IVsProject::GetMkDocument Method (UInt32, String^)

Visual Studio 2015

Returns a document moniker.

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

Syntax

C++

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

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:

C++

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.