IVsRunningDocumentTable.GetDocumentInfo(UInt32, UInt32, UInt32, UInt32, String, IVsHierarchy, UInt32, IntPtr) Méthode

Définition

Retourne des informations sur un document inscrit dans le RDT, en fonction du 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

Paramètres

docCookie
UInt32

[in] Valeur abstraite qui représente le document pour lequel des informations ont été demandées.

pgrfRDTFlags
UInt32

[out] Retourne les indicateurs dont les valeurs sont extraites de l'énumération _VSRDTFLAGS.

pdwReadLocks
UInt32

[out] Retourne le nombre de verrous de lecture dans le document.

pdwEditLocks
UInt32

[out] Retourne le nombre de verrous de modification dans le document.

pbstrMkDocument
String

[out] Retourne le chemin d'accès et le nom de fichier du document.

ppHier
IVsHierarchy

[out, optional] Retourne l'interface IVsHierarchy.

pitemid
UInt32

[out, optional] Identificateur d'élément du document. Il s'agit d'un identificateur unique, d'une des valeurs suivantes : VSITEMID_NIL, VSITEMID_ROOT ou VSITEMID_SELECTION.

ppunkDocData
IntPtr

[out, optional] Retourne une interface IUnknown.

Retours

Int32

Si la méthode réussit, retourne S_OK. En cas d'échec, retourne un code d'erreur.

Remarques

Signature COM

À partir de 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  
);  

Le ppunkDocData paramètre représente l’objet de données de document associé au document inscrit. En général, IVsPersistDocData les IVsDocDataFileChangeControl interfaces et sont obtenues à partir de cet IUnknown objet.

S’applique à