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)
Syntax
'Declaration
Function GetDocumentInfo ( _
docCookie As UInteger, _
<OutAttribute> ByRef pgrfRDTFlags As UInteger, _
<OutAttribute> ByRef pdwReadLocks As UInteger, _
<OutAttribute> ByRef pdwEditLocks As UInteger, _
<OutAttribute> ByRef pbstrMkDocument As String, _
<OutAttribute> ByRef ppHier As IVsHierarchy, _
<OutAttribute> ByRef pitemid As UInteger, _
<OutAttribute> ByRef ppunkDocData As IntPtr _
) As Integer
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
)
int GetDocumentInfo(
[InAttribute] unsigned int docCookie,
[OutAttribute] unsigned int% pgrfRDTFlags,
[OutAttribute] unsigned int% pdwReadLocks,
[OutAttribute] unsigned int% pdwEditLocks,
[OutAttribute] String^% pbstrMkDocument,
[OutAttribute] IVsHierarchy^% ppHier,
[OutAttribute] unsigned int% pitemid,
[OutAttribute] IntPtr% ppunkDocData
)
abstract GetDocumentInfo :
docCookie:uint32 *
pgrfRDTFlags:uint32 byref *
pdwReadLocks:uint32 byref *
pdwEditLocks:uint32 byref *
pbstrMkDocument:string byref *
ppHier:IVsHierarchy byref *
pitemid:uint32 byref *
ppunkDocData:IntPtr byref -> int
function GetDocumentInfo(
docCookie : uint,
pgrfRDTFlags : uint,
pdwReadLocks : uint,
pdwEditLocks : uint,
pbstrMkDocument : String,
ppHier : IVsHierarchy,
pitemid : uint,
ppunkDocData : IntPtr
) : int
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.
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.
.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.