This topic has not yet been rated - Rate this topic

IVsProject2.GetMkDocument Method

Visual Studio 2010

Returns a document moniker.

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

Syntax

C++

JScript

int GetMkDocument(
	uint itemid,
	out 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. See VSITEMID.

pbstrMkDocument: Type: System.String
[out] Pointer to a document moniker in a BSTR. It is fully qualified text uniquely describing 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.

Implements

IVsProject.GetMkDocument(UInt32, String)

Remarks

COM Signature

From vsshell.idl:

C++

HRESULT IVsProject2::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.

Reference

IVsProject2 Interface

Microsoft.VisualStudio.Shell.Interop Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD