IVsRunningDocumentTable.GetDocumentInfo – metoda (UInt32, UInt32, UInt32, UInt32, String, IVsHierarchy, UInt32, IntPtr)

Článek
08/05/2016

Vrátí informace o dokumentu je registrován v RDT, uveden v souboru cookie.

Obor názvů: Microsoft.VisualStudio.Shell.Interop
Sestavení: Microsoft.VisualStudio.Shell.Interop (v Microsoft.VisualStudio.Shell.Interop.dll)

Syntaxe

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(
    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:nativeint byref -> int

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

Parametry

docCookie
[v] Abstraktní hodnotu reprezentující dokument, pro který byly vyžádány informace.

pgrfRDTFlags
[výstup] Vrátí příznaky, jejichž hodnoty jsou převzaty z _VSRDTFLAGS výčtu.

pdwReadLocks
[výstup] Vrátí počet čtení uzamčení dokumentu.

pdwEditLocks
[výstup] Vrátí počet uzamčení úpravy dokumentu.

pbstrMkDocument
[výstup] Vrátí cestu a název dokumentu.

ppHier
[výstup, volitelné] Vrátí IVsHierarchy rozhraní.

pitemid
[výstup, volitelné] Identifikátor položky dokladu.Toto je jedinečný identifikátor nebo může být jedna z následujících hodnot: VSITEMID_NIL, VSITEMID_ROOT, nebo VSITEMID_SELECTION.

ppunkDocData
[výstup, volitelné] Vrátí IUnknown rozhraní.

Vrácená hodnota

Type: System.Int32

Pokud metoda uspěje, vrací S_OK.Pokud se nezdaří, vrátí kód chyby.

Poznámky

Podpis COM

Z 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
);

ppunkDocData Parametr představuje datový objekt dokumentu přidružené registrované dokumentu.Obvykle IVsPersistDocData a IVsDocDataFileChangeControl rozhraní jsou získány z tohoto IUnknown objektu.

Viz také

IVsRunningDocumentTable – rozhraní
Microsoft.VisualStudio.Shell.Interop – obor názvů

Zpátky na začátek

Sdílet prostřednictvím