IVsProject.GetMkDocument Method

Article
03/06/2013

Returns a document moniker.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Function GetMkDocument ( _
    itemid As UInteger, _
    <OutAttribute> ByRef pbstrMkDocument As String _
) As Integer

int GetMkDocument(
    uint itemid,
    out string pbstrMkDocument
)

int GetMkDocument(
    [InAttribute] unsigned int itemid, 
    [OutAttribute] String^% pbstrMkDocument
)

abstract GetMkDocument : 
        itemid:uint32 * 
        pbstrMkDocument:string byref -> int

function GetMkDocument(
    itemid : uint, 
    pbstrMkDocument : String
) : int

Parameters

itemid
Type: System.UInt32
[in] Item identifier corresponding to a node in this project's hierarchy. Should be VSITEMID_ROOT or other valid item identifier.

pbstrMkDocument
Type: System.String%
[out] Pointer to a document moniker in a BSTR. It is fully qualified text uniquely identifying the document represented by the itemid parameter.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsProject::GetMkDocument(
   [in] VSITEMID itemid,
   [out] BSTR *pbstrMkDocument
);

A document moniker is used as a unique index into the Running Document Table. A document moniker for an item in a file-based project is the item's file path. Project types, which do not store their items in files, uniquely identify those items in a project-specific manner. File-based project types must return the path from this method.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via