Metoda IVsRunningDocumentTable2.FindAndLockDocumentEx — (UInt32, String, IVsHierarchy, UInt32, IVsHierarchy, UInt32, IntPtr, UInt32)

Artykuł
08/06/2016

Lokalizuje dokumentu w Normalizacją przy użyciu nazwy pliku dokumentu, a następnie uzyskuje blokadę odczytu lub edycji w tym dokumencie.

Przestrzeń nazw: Microsoft.VisualStudio.Shell.Interop
Zestaw: Microsoft.VisualStudio.Shell.Interop.8.0 (w Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Składnia

int FindAndLockDocumentEx(
    uint grfRDTLockType,
    string pszMkDocument,
    IVsHierarchy pHierPreferred,
    uint itemidPreferred,
    out IVsHierarchy ppHierActual,
    out uint pitemidActual,
    out IntPtr ppunkDocDataActual,
    out uint pdwCookie
)

int FindAndLockDocumentEx(
    unsigned int grfRDTLockType,
    String^ pszMkDocument,
    IVsHierarchy^ pHierPreferred,
    unsigned int itemidPreferred,
    [OutAttribute] IVsHierarchy^% ppHierActual,
    [OutAttribute] unsigned int% pitemidActual,
    [OutAttribute] IntPtr% ppunkDocDataActual,
    [OutAttribute] unsigned int% pdwCookie
)

abstract FindAndLockDocumentEx : 
        grfRDTLockType:uint32 *
        pszMkDocument:string *
        pHierPreferred:IVsHierarchy *
        itemidPreferred:uint32 *
        ppHierActual:IVsHierarchy byref *
        pitemidActual:uint32 byref *
        ppunkDocDataActual:nativeint byref *
        pdwCookie:uint32 byref -> int

Function FindAndLockDocumentEx (
    grfRDTLockType As UInteger,
    pszMkDocument As String,
    pHierPreferred As IVsHierarchy,
    itemidPreferred As UInteger,
    <OutAttribute> ByRef ppHierActual As IVsHierarchy,
    <OutAttribute> ByRef pitemidActual As UInteger,
    <OutAttribute> ByRef ppunkDocDataActual As IntPtr,
    <OutAttribute> ByRef pdwCookie As UInteger
) As Integer

Parametry

grfRDTLockType
Type: System.UInt32

[in] Flagi, których wartości są pobierane z _VSRDTFLAGS wyliczenia.

pszMkDocument
Type: System.String

[in] Ścieżka do dokumentu znajduje.

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

[out, opcjonalny] Zwraca preferowane IVsHierarchy interfejs znajduje dokumentu.

itemidPreferred
Type: System.UInt32

[out, opcjonalny] Zwraca identyfikator elementu znajduje dokumentu. Jest to unikatowy identyfikator lub może być jedną z następujących wartości: VSITEMID_NIL, VSITEMID_ROOT, lub VSITEMID_SELECTION.

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

[out, opcjonalny] Zwraca rzeczywiste IVsHierarchy interfejs znajduje dokumentu.

pitemidActual
Type: System.UInt32

[out, opcjonalny] Zwraca identyfikator elementu znajduje dokumentu. Jest to unikatowy identyfikator lub może być jedną z następujących wartości: VSITEMID_NIL, VSITEMID_ROOT, lub VSITEMID_SELECTION.

ppunkDocDataActual
Type: System.IntPtr

[out, opcjonalny] Zwraca IUnknown interfejsu.

pdwCookie
Type: System.UInt32

[out, opcjonalny] Zwraca wartość abstrakcyjne dla dokumentu.

Wartość zwracana

Type: System.Int32

Jeśli metoda zakończy się pomyślnie, zwraca S_OK. Jeśli nie, zwraca kod błędu.

Uwagi

Ta metoda jest podobna do FindAndLockDocument ale również umożliwia określenie parę preferowanych hierarchii/itemid dokumentu w przypadku, gdy potrzebne jest RDT_EditLock i dokumentu jest obecnie zarejestrowane za pomocą tylko RDT_ReadLock nie hierarchii/itemid przypisane. W takim przypadku FindAndLockDocument normalnie zwracana E_UNEXPECTED. Ta metoda nie zarejestruje dokumentu w tabeli dokumentu uruchomiony, jeśli nie jest już zarejestrowana.

Podpis COM

Z vsshell80.idl:

HRESULT FindAndLockDocumentEx(
    [in] VSRDTFLAGS grfRDTLockType,
    [in] LPCOLESTR pszMkDocument,
    [in] IVsHierarchy *pHierPreferred,
    [in] VSITEMID itemidPreferred,
    [out] IVsHierarchy **ppHierActual,
    [out] VSITEMID *pitemidActual,
    [out] IUnknown **ppunkDocDataActual,
    [out] VSCOOKIE *pdwCookie
);

Zobacz też

Interfejs IVsRunningDocumentTable2
Przestrzeń nazw Microsoft.VisualStudio.Shell.Interop

Powrót do początku

Udostępnij za pośrednictwem