IVsHierarchy.GetCanonicalName(UInt32, String) Método

Definição

Retorna um nome de cadeia de caracteres exclusivo para um item na hierarquia. Usado para persistência do espaço de trabalho, como memorizar posições de janela.

public:
 int GetCanonicalName(System::UInt32 itemid, [Runtime::InteropServices::Out] System::String ^ % pbstrName);
int GetCanonicalName(unsigned int itemid, [Runtime::InteropServices::Out] std::wstring const & & pbstrName);
public int GetCanonicalName (uint itemid, out string pbstrName);
abstract member GetCanonicalName : uint32 * string -> int
Public Function GetCanonicalName (itemid As UInteger, ByRef pbstrName As String) As Integer

Parâmetros

itemid
UInt32

no Identificador do item de hierarquia. Para obter uma lista de itemid valores, consulte VSITEMID .

pbstrName
String

fora Ponteiro para o nome canônico do item de hierarquia.

Retornos

Int32

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

Comentários

Uma hierarquia é um objeto que contém muitos itens, mas não necessariamente contém um objeto para cada um desses itens. Portanto, para obter informações sobre qualquer um dos itens de hierarquia, você precisa consultar o objeto de hierarquia para obter essas informações. O identificador de item ( itemid ) é usado para identificar o item solicitado nessa 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.

Os nomes canônicos não são alterados entre as sessões do ambiente, mas os identificadores de item. Use esse método para gerenciar a persistência do espaço de trabalho, como memorizar as posições da janela.

Observação

O ambiente normalmente chama esse método, mas 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 (ID do item), dado o nome canônico de um item.

Assinatura COM

De VSShell. idl:

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

Aplica-se a