IShellFolder::GetDisplayNameOf

9/9/2008

Este método recupera o nome exibir para o objeto especificado arquivo ou subpasta.

Syntax

HRESULT GetDisplayNameOf(
  LPCITEMIDLIST pidl,
  DWORD uFlags,
  LPSTRRET lpName
);

Parameters

• pidl
  [no] Ponteiro para um ITEMIDLIST estrutura (PIDL) que identifica exclusivamente o objeto arquivo ou subpasta relativo para a pasta pai.

• uFlags
  [no] Sinalizadores usados para o tipo de nome exibir solicitação para retornar. Para obter uma lista dos valores possíveis, consulte o SHGNO tipo enumerado.

• lpName
  [out] Endereço de um STRRET estrutura na qual retornar o nome exibir. O tipo de nome retornado nessa estrutura pode ser o tipo solicitado, mas a pasta shell pode retornar um tipo diferente.

Return Value

Retorna NOERROR se bem-sucedido, ou um valor de erro caso contrário.

Remarks

Normalmente, pidl Pode referir apenas aos itens contidos pela pasta pai. O PIDL deve ser único-nível e conter exatamente um SHITEMID estrutura seguida por um zero terminação. Se você desejar para recuperar nome de um item que está mais profundo que um nível Away from a pasta pai, use exibir SHBindToParent Para BIND com da o item pasta pai imediata e transmitir, em seguida, o item é único-nível PIDL para IShellFolder::GetDisplayNameOf.

Além disso, se o sinalizador SHGDN_FORPARSING for definida no uFlags e o sinalizador SHGDN_INFOLDER não é definido, pidl Pode referir a um objeto em qualquer nível abaixo a pasta pai na hierarquia de espaço para nome. Neste maiúsculas e minúsculas, pidl Pode ser um PIDL vários níveis, relativo para a pasta pai e pode conter múltiplo SHITEMID estruturas.

A maneira mais simples recuperar o nome exibir a partir de estrutura apontado pelo lpName é para transmitir para StrRetToBuf. Essa função leva um STRRET estrutura e retorna o nome. Você também pode examinar a estrutura uType membro e recuperar o nome a partir de apropriado membro.

Os sinalizadores especificados na uFlags São as dicas sobre o uso pretendido do nome. Eles não garantem que IShellFolder Retornará a forma solicitada do nome. Se essa forma não estiver disponível, um diferentes um pode ser retornado. Em particular, não há nenhuma garantia de que o nome retornado por sinalizador de SHGDN_FORPARSING será analisado com êxito por IShellFolder::ParseDisplayName. Existem também algumas combinações de sinalizadores que podem causar um IShellFolder::GetDisplayNameOf chamar com um subseqüentes IShellFolder::ParseDisplayName chamar para retornar o original não lista identificador. Esta ocorrência é excepcional, mas você deve verificar para ter certeza.

A análise nome que é retornado quando uFlags Tenha o sinalizador SHGDN_FORPARSING conjunto não é necessariamente um seqüência de caracteres de texto comum. Pastas virtuais, como Meu computador pode retornar um seqüência de caracteres que contém o objeto pasta do GUID a forma ":: {GUID} ". Os desenvolvedores que implementar IShellFolder::GetDisplayNameOf são incentivados a retornar nomes de análise que são como fechar aos nomes de exibir quanto possível, porque geralmente precisa de usuário final para tipo ou editar esses nomes.

Requirements

Header	shobjidl.h, shobjidl.idl
Library	Developer Implemented
Windows Embedded CE	Windows CE .NET 4.2 and later

See Also

Reference

IShellFolder
ITEMIDLIST
SHGNO
STRRET
SHITEMID
SHBindToParent
StrRetToBuf
IShellFolder::ParseDisplayName