IVsProject.GetMkDocument(UInt32, String) Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assembly:
Microsoft.VisualStudio.Shell.Interop.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.11.40262

Returns a document moniker.

public:
 int GetMkDocument(System::UInt32 itemid, [Runtime::InteropServices::Out] System::String ^ % pbstrMkDocument);
int GetMkDocument(unsigned int itemid, [Runtime::InteropServices::Out] std::wstring const & & pbstrMkDocument);
public int GetMkDocument (uint itemid, out string pbstrMkDocument);
abstract member GetMkDocument : uint32 * string -> int
Public Function GetMkDocument (itemid As UInteger, ByRef pbstrMkDocument As String) As Integer

Parameters

itemid
UInt32

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

pbstrMkDocument
String

[out] Pointer to a document moniker in a BSTR. It is fully qualified text uniquely identifying the document represented by the itemid parameter.

Returns

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.

Applies to