Método IVsRunningDocumentTable.RegisterDocumentLockHolder (UInt32, UInt32, IVsDocumentLockHolder, UInt32)

Artigo
08/03/2016

Publicado: abril de 2016

Registra um proprietário de bloqueio de documento na tabela de documento em execução.

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

Sintaxe

int RegisterDocumentLockHolder(
    uint grfRDLH,
    uint dwCookie,
    IVsDocumentLockHolder pLockHolder,
    out uint pdwLHCookie
)

int RegisterDocumentLockHolder(
    unsigned int grfRDLH,
    unsigned int dwCookie,
    IVsDocumentLockHolder^ pLockHolder,
    [OutAttribute] unsigned int% pdwLHCookie
)

abstract RegisterDocumentLockHolder : 
        grfRDLH:uint32 *
        dwCookie:uint32 *
        pLockHolder:IVsDocumentLockHolder *
        pdwLHCookie:uint32 byref -> int

Function RegisterDocumentLockHolder (
    grfRDLH As UInteger,
    dwCookie As UInteger,
    pLockHolder As IVsDocumentLockHolder,
    <OutAttribute> ByRef pdwLHCookie As UInteger
) As Integer

Parâmetros

grfRDLH
[in] Isso é zero ou um sinalizador de retirada da __VSREGDOCLOCKHOLDER enumeração.

dwCookie
[in] Valor abstrato que representa o documento aberto para o qual o bloqueio de leitura ou edição está para ser lançada.

pLockHolder
[in] Um IVsDocumentLockHolder interface que representa o proprietário do bloqueio de documento para o documento registrado.

pdwLHCookie
[out] Valor exclusivo que representa o proprietário do bloqueio de documento.

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::RegisterDocumentLockHolder(
   [in] VSREGDOCLOCKHOLDER     grfRDLH,
   [in] VSCOOKIE               dwCookie,
   [in] IVsDocumentLockHolder *pLockHolder,
   [out] VSCOOKIE             *pdwLHCookie
);

Usar esse identificador retornado na pdwLHCookie parâmetro para cancelar o registro o proprietário do bloqueio de documento, chamando o UnregisterDocumentLockHolder método.

O dwCookie parâmetro é o mesmo valor que é retornado de FindAndLockDocument ou RegisterAndLockDocument métodos.

Consulte também

Interface IVsRunningDocumentTable
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

Compartilhar via