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

Artigo
08/03/2016

Publicado: abril de 2016

Cria uma entrada na tabela de documento em execução quando um documento for criado ou aberto.

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

Sintaxe

int RegisterAndLockDocument(
    uint grfRDTLockType,
    string pszMkDocument,
    IVsHierarchy pHier,
    uint itemid,
    IntPtr punkDocData,
    out uint pdwCookie
)

int RegisterAndLockDocument(
    unsigned int grfRDTLockType,
    String^ pszMkDocument,
    IVsHierarchy^ pHier,
    unsigned int itemid,
    IntPtr punkDocData,
    [OutAttribute] unsigned int% pdwCookie
)

abstract RegisterAndLockDocument : 
        grfRDTLockType:uint32 *
        pszMkDocument:string *
        pHier:IVsHierarchy *
        itemid:uint32 *
        punkDocData:nativeint *
        pdwCookie:uint32 byref -> int

Function RegisterAndLockDocument (
    grfRDTLockType As UInteger,
    pszMkDocument As String,
    pHier As IVsHierarchy,
    itemid As UInteger,
    punkDocData As IntPtr,
    <OutAttribute> ByRef pdwCookie As UInteger
) As Integer

Parâmetros

grfRDTLockType
[in] Extraído de sinalizadores de _VSRDTFLAGS enumeração.Os sinalizadores devem incluir tanto RDT_EditLock ou RDT_ReadLock.

pszMkDocument
[in] Caminho para o documento.

pHier
[in] Retorna o IVsHierarchy interface da hierarquia que é proprietário do documento.Só pode ser um valor nulo se um bloqueio de leitura foi obtido.

itemid
[in] Identificador de item do documento na hierarquia.Este é um identificador exclusivo ou pode ser um dos seguintes valores: VSITEMID_NIL, VSITEMID_ROOT, ou VSITEMID_SELECTION.

punkDocData
[in] O IUnknown interface do documento.Um valor nulo não indica que nenhum objeto de documento pode ser mantido.

pdwCookie
[out] Retorna um valor abstrato que representa o documento em que o RDT.

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::RegisterAndLockDocument(
   [in] VSRDTFLAGS    grfRDTLockType,
   [in] LPCOLESTR     pszMkDocument,
   [in] IVsHierarchy *pHier,
   [in] VSITEMID      itemid,
   [in] IUnknown     *punkDocData,
   [out] VSCOOKIE    *pdwCookie
);

O punkDocData parâmetro representa o objeto de dados de documento a ser registrado.Qualquer pacote que chama o RegisterAndLockDocument método cria esse objeto de documento que deve implementar pelo menos o IVsPersistDocData e IVsDocDataFileChangeControl interfaces.

Consulte também

Interface IVsRunningDocumentTable
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

Compartilhar via