Compartilhar via


Função GetThemeDocumentationProperty (uxtheme.h)

Recupera o valor de uma propriedade de tema da seção de documentação do arquivo de tema especificado.

Sintaxe

HRESULT GetThemeDocumentationProperty(
  [in]  LPCWSTR pszThemeName,
  [in]  LPCWSTR pszPropertyName,
  [out] LPWSTR  pszValueBuff,
  [in]  int     cchMaxValChars
);

Parâmetros

[in] pszThemeName

Tipo: LPCWSTR

Ponteiro para uma cadeia de caracteres que contém o nome do arquivo de tema que será aberto para consultar a propriedade .

[in] pszPropertyName

Tipo: LPCWSTR

Ponteiro para uma cadeia de caracteres que contém o nome da propriedade de tema a ser consultada. Pode ser um dos valores a seguir.

Valor Significado
SZ_THDOCPROP_DISPLAYNAME
Recupera o nome de exibição do tema.
SZ_THDOCPROP_TOOLTIP
Recupera a dica de ferramenta associada a este tema.
SZ_THDOCPROP_AUTHOR
Recupera o nome do autor do tema.
SZ_THDOCPROP_CANONICALNAME
Recupera o nome do tema.

[out] pszValueBuff

Tipo: LPWSTR

Ponteiro para um buffer de cadeia de caracteres que recebe o valor da cadeia de caracteres de propriedade.

[in] cchMaxValChars

Tipo: int

Valor do tipo int que especifica o número máximo de caracteres que pszValueBuff pode conter.

Retornar valor

Tipo: HRESULT

Se essa função for bem-sucedida, ela retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Se a propriedade de tema tiver sido localizada na tabela de cadeia de caracteres de arquivos de tema, essa função retornará a versão localizada.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho uxtheme.h
Biblioteca UxTheme.lib
DLL UxTheme.dll