Export (0) Print
Expand All

IVsRunningDocumentTable.GetDocumentInfo Method

Returns information about a document registered in the RDT, given the cookie.

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

int GetDocumentInfo(
	uint docCookie,
	out uint pgrfRDTFlags,
	out uint pdwReadLocks,
	out uint pdwEditLocks,
	out string pbstrMkDocument,
	out IVsHierarchy ppHier,
	out uint pitemid,
	out IntPtr ppunkDocData
)

Parameters

docCookie
Type: UInt32

[in] Abstract value representing the document for which information was requested.

pgrfRDTFlags
Type: UInt32

[out] Returns flags whose values are taken from the _VSRDTFLAGS enumeration.

pdwReadLocks
Type: UInt32

[out] Returns the number of read locks on the document.

pdwEditLocks
Type: UInt32

[out] Returns the number of edit locks on the document.

pbstrMkDocument
Type: String

[out] Returns the path and file name of the document.

ppHier
Type: Microsoft.VisualStudio.Shell.Interop.IVsHierarchy

[out, optional] Returns the IVsHierarchy interface.

pitemid
Type: UInt32

[out, optional] Item identifier of the document. This is a unique identifier or it can be one of the following values: VSITEMID_NIL, VSITEMID_ROOT, or VSITEMID_SELECTION.

ppunkDocData
Type: IntPtr

[out, optional] Returns an IUnknown interface.

Return Value

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

COM Signature

From vsshell.idl:

HRESULT IVsRunningDocumentTable::GetDocumentInfo(
   [in] VSCOOKIE        docCookie,
   [out] VSRDTFLAGS    *pgrfRDTFlags,
   [out] DWORD         *pdwReadLocks,
   [out] DWORD         *pdwEditLocks,
   [out] BSTR          *pbstrMkDocument,
   [out] IVsHierarchy **ppHier,
   [out] VSITEMID      *pitemid,
   [out] IUnknown     **ppunkDocData
);

The ppunkDocData parameter represents the document data object associated with the registered document. Typically, the IVsPersistDocData and IVsDocDataFileChangeControl interfaces are obtained from this IUnknown object.

Show:
© 2015 Microsoft