Método IVsHierarchy.GetCanonicalName (UInt32, String)

Artigo
08/03/2016

Publicado: abril de 2016

Retorna um nome exclusivo, de seqüência de caracteres para um item na hierarquia.Usado para persistência de espaço de trabalho, como, por exemplo, lembrando a posição das janelas.

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

Sintaxe

int GetCanonicalName(
    uint itemid,
    out string pbstrName
)

int GetCanonicalName(
    unsigned int itemid,
    [OutAttribute] String^% pbstrName
)

abstract GetCanonicalName : 
        itemid:uint32 *
        pbstrName:string byref -> int

Function GetCanonicalName (
    itemid As UInteger,
    <OutAttribute> ByRef pbstrName As String
) As Integer

Parâmetros

itemid
[in] Identificador do item de hierarquia.Para obter uma lista de itemid valores, consulte VSITEMID.

pbstrName
[out] Ponteiro para o nome canônico de um item de hierarquia.

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

Uma hierarquia é um objeto que contém muitos itens, mas não necessariamente conter um objeto para cada um desses itens.Assim, para obter informações sobre qualquer um dos itens de hierarquia, você precisa consultar o objeto de hierarquia para essas informações.O identificador do item (itemid) é usado para identificar o item solicitado dessa consulta.Usando o GetCanonicalName método, você passa o itemid e o nome canônico é retornado.O nome canônico é um nome exclusivo usado para distinguir um item específico na hierarquia de todos os outros itens na hierarquia.

Nomes canônicos não alteram entre sessões do ambiente, mas fazem de identificadores de item.Use esse método para gerenciar a persistência de espaço de trabalho, como, por exemplo, lembrando a posição das janelas.

Observação
Normalmente, o ambiente chama este método, mas ele pode ser chamado por qualquer pessoa com um objeto de hierarquia e um identificador de item específico.

Use ParseCanonicalName para determinar um identificador de item (item ID), receberá o nome canônico para um item.

COM assinatura

De vsshell.idl:

HRESULT IVsHierarchy::GetCanonicalName(
   [in] VSITEMID itemid,
   [out] BSTR *pbstrName
);

Consulte também

Interface IVsHierarchy
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo

Compartilhar via