IVsRunningDocumentTable2.FindAndLockDocumentEx(UInt32, String, IVsHierarchy, UInt32, IVsHierarchy, UInt32, IntPtr, UInt32) Methode

Definition

Sucht ein Dokument im RDT mithilfe des Dokumentendateinamens, und erhält dann eine Lese- oder Bearbeitungssperre für dieses Dokument.

public:
 int FindAndLockDocumentEx(System::UInt32 grfRDTLockType, System::String ^ pszMkDocument, Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ pHierPreferred, System::UInt32 itemidPreferred, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ % ppHierActual, [Runtime::InteropServices::Out] System::UInt32 % pitemidActual, [Runtime::InteropServices::Out] IntPtr % ppunkDocDataActual, [Runtime::InteropServices::Out] System::UInt32 % pdwCookie);
public int FindAndLockDocumentEx (uint grfRDTLockType, string pszMkDocument, Microsoft.VisualStudio.Shell.Interop.IVsHierarchy pHierPreferred, uint itemidPreferred, out Microsoft.VisualStudio.Shell.Interop.IVsHierarchy ppHierActual, out uint pitemidActual, out IntPtr ppunkDocDataActual, out uint pdwCookie);
abstract member FindAndLockDocumentEx : uint32 * string * Microsoft.VisualStudio.Shell.Interop.IVsHierarchy * uint32 * IVsHierarchy * uint32 * nativeint * uint32 -> int
Public Function FindAndLockDocumentEx (grfRDTLockType As UInteger, pszMkDocument As String, pHierPreferred As IVsHierarchy, itemidPreferred As UInteger, ByRef ppHierActual As IVsHierarchy, ByRef pitemidActual As UInteger, ByRef ppunkDocDataActual As IntPtr, ByRef pdwCookie As UInteger) As Integer

Parameter

grfRDTLockType
UInt32

[in] Flags, deren Werte aus der _VSRDTFLAGS-Enumeration übernommen werden.

pszMkDocument
String

[in] Pfad zum gefundenen Dokument.

pHierPreferred
IVsHierarchy

[out, optional] Gibt die bevorzugte IVsHierarchy-Schnittstelle für das lokalisierte Dokument zurück.

itemidPreferred
UInt32

[out, optional] Gibt einen Elementbezeichner des gefundenen Dokuments zurück. Dies ist ein eindeutiger Bezeichner oder kann einer der folgenden Werte sein: VSITEMID_NIL, VSITEMID_ROOT oder VSITEMID_SELECTION.

ppHierActual
IVsHierarchy

[out, optional] Gibt die tatsächliche IVsHierarchy-Schnittstelle für das lokalisierte Dokument zurück.

pitemidActual
UInt32

[out, optional] Gibt einen Elementbezeichner des gefundenen Dokuments zurück. Dies ist ein eindeutiger Bezeichner oder kann einer der folgenden Werte sein: VSITEMID_NIL, VSITEMID_ROOT oder VSITEMID_SELECTION.

ppunkDocDataActual
IntPtr

[out, optional] Gibt die IUnknown-Schnittstelle zurück.

pdwCookie
UInt32

[out, optional] Gibt einen abstrakten Wert für das Dokument zurück.

Gibt zurück

Int32

Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben. Bei einem Fehler wird ein Fehlercode zurückgegeben.

Hinweise

Diese Methode ähnelt der FindAndLockDocument Angabe eines bevorzugten Hierarchy-/Itemid-Paars für das Dokument, wenn ein RDT_EditLock erwünscht ist und das Dokument derzeit nur mit einer RDT_ReadLock registriert ist, der keine Hierarchie/Itemid zugewiesen ist. In diesem Fall hätte FindAndLockDocument E_UNEXPECTED zurückgegeben. Diese Methode registriert das Dokument nicht in der laufenden dokumententabelle, wenn es zurzeit nicht registriert ist.

COM-Signatur

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

Gilt für