IVsRunningDocumentTable.GetDocumentInfo Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

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

public:
 int GetDocumentInfo(System::UInt32 docCookie, [Runtime::InteropServices::Out] System::UInt32 % pgrfRDTFlags, [Runtime::InteropServices::Out] System::UInt32 % pdwReadLocks, [Runtime::InteropServices::Out] System::UInt32 % pdwEditLocks, [Runtime::InteropServices::Out] System::String ^ % pbstrMkDocument, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ % ppHier, [Runtime::InteropServices::Out] System::UInt32 % pitemid, [Runtime::InteropServices::Out] IntPtr % ppunkDocData);

public int GetDocumentInfo (uint docCookie, out uint pgrfRDTFlags, out uint pdwReadLocks, out uint pdwEditLocks, out string pbstrMkDocument, out Microsoft.VisualStudio.Shell.Interop.IVsHierarchy ppHier, out uint pitemid, out IntPtr ppunkDocData);

abstract member GetDocumentInfo : uint32 * uint32 * uint32 * uint32 * string * IVsHierarchy * uint32 * nativeint -> int

Public Function GetDocumentInfo (docCookie As UInteger, ByRef pgrfRDTFlags As UInteger, ByRef pdwReadLocks As UInteger, ByRef pdwEditLocks As UInteger, ByRef pbstrMkDocument As String, ByRef ppHier As IVsHierarchy, ByRef pitemid As UInteger, ByRef ppunkDocData As IntPtr) As Integer

Parameters

docCookie

UInt32

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

pgrfRDTFlags

UInt32

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

pdwReadLocks

UInt32

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

pdwEditLocks

UInt32

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

pbstrMkDocument

String

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

ppHier

IVsHierarchy

[out, optional] Returns the IVsHierarchy interface.

pitemid

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

IntPtr

nativeint

[out, optional] Returns an IUnknown interface.

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 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.