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

Artigo
08/03/2016

Publicado: abril de 2016

Retorna informações sobre um documento registrado no RDT, dado o cookie.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (em Microsoft.VisualStudio.Shell.Interop.dll)

Sintaxe

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

Parâmetros

docCookie
[in] Representando o documento para o qual foram solicitadas informações de valor abstrato.

pgrfRDTFlags
[out] Retorna sinalizadores cujos valores são obtidos a partir do _VSRDTFLAGS enumeração.

pdwReadLocks
[out] Retorna o número de bloqueios de leitura no documento.

pdwEditLocks
[out] Retorna o número de bloqueios de edição no documento.

pbstrMkDocument
[out] Retorna o caminho e o nome do documento.

ppHier
[out, opcional] Retorna o IVsHierarchy interface.

pitemid
[out, opcional] Identificador de item do documento.Este é um identificador exclusivo ou pode ser um dos seguintes valores: VSITEMID_NIL, VSITEMID_ROOT, ou VSITEMID_SELECTION.

ppunkDocData
[out, opcional] Retorna um IUnknown interface.

Valor de retorno

Type: System.Int32

Se o método for bem-sucedido, ele retorna S_OK.Se ele falhar, ele retorna um código de erro.

Comentários

COM assinatura

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

O ppunkDocData parâmetro representa o objeto de dados de documento associado ao documento registrado.Normalmente, o IVsPersistDocData e IVsDocDataFileChangeControl interfaces são obtidos a partir dessa IUnknown objeto.

Consulte também

Interface IVsRunningDocumentTable
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

Compartilhar via