Método IPropertySystem::FormatForDisplay (propsys.h)

Obtém uma representação de cadeia de caracteres Unicode formatada de um valor de propriedade.

Sintaxe

HRESULT FormatForDisplay(
  [in]  REFPROPERTYKEY        key,
  [in]  REFPROPVARIANT        propvar,
  [in]  PROPDESC_FORMAT_FLAGS pdff,
  [out] LPWSTR                pszText,
  [in]  DWORD                 cchText
);

Parâmetros

[in] key

Tipo: REFPROPERTYKEY

Uma referência à chave de propriedade solicitada.

[in] propvar

Tipo: REFPROPVARIANT

Uma referência a uma estrutura PROPVARIANT que contém o tipo e o valor da propriedade.

[in] pdff

Tipo: PROPDESC_FORMAT_FLAGS

O formato da cadeia de caracteres de propriedade. Consulte PROPDESC_FORMAT_FLAGS para obter valores possíveis.

[out] pszText

Tipo: LPWSTR

Recebe o valor formatado como uma cadeia de caracteres Unicode terminada em nulo. O aplicativo de chamada deve alocar memória para o buffer.

[in] cchText

Tipo: DWORD

O comprimento do buffer em pszText no WCHARs, incluindo o NULL de terminação. O tamanho máximo é 0x8000 (32K).

Retornar valor

Tipo: HRESULT

Retorna um dos valores a seguir.

Comentários

Você deve inicializar o COM (Component Object Model) com CoInitialize ou OleInitialize antes de chamar IPropertySystem::FormatForDisplay.

Quando ele é bem-sucedido, esse método obtém uma representação de cadeia de caracteres Unicode formatada de um valor de propriedade para um PROPERTYKEY especificado e um ou mais PROPDESC_FORMAT_FLAGS. Se PROPERTYKEY não for reconhecido pelo subsistema de esquema, IPropertySystem::FormatForDisplay tentará formatar o valor de acordo com seu VARTYPE.

A finalidade desse método é converter dados em uma cadeia de caracteres adequada para exibição para o usuário. O valor é formatado de acordo com a localidade atual, o idioma do usuário, o PROPDESC_FORMAT_FLAGS e a descrição da propriedade especificada pela chave de propriedade. Para obter informações sobre como o esquema de descrição da propriedade influencia a formatação do valor, consulte displayInfo, stringFormat, booleanFormat, numberFormat, NMDATETIMEFORMAT e enumeratedList. Normalmente, os PROPDESC_FORMAT_FLAGS são usados para modificar o formato prescrito pela descrição da propriedade.

A cadeia de caracteres de saída pode conter caracteres direcionais Unicode. Esses caracteres sem espaçamento influenciam o algoritmo bidirecional Unicode para que os valores apareçam corretamente quando uma linguagem LTR (da esquerda para a direita) é desenhada em uma janela da direita para a esquerda (RTL) e vice-versa. Esses caracteres incluem o seguinte: "\x200e", "\x200f", "\x202a", "\x202b", "\x202c", "\x202d", "\x202e".

As propriedades na tabela a seguir usam formatos especiais e não são afetadas pelo PROPDESC_FORMAT_FLAGS (exemplos citados são para cadeias de caracteres com uma localidade atual definida como inglês; normalmente, a saída é localizada, exceto quando indicada).

Se a chave de propriedade não corresponder a uma descrição de propriedade em nenhum dos esquemas de propriedade registrados, esse método escolherá um formato com base no tipo do valor, conforme descrito na tabela a seguir.

Requisitos