Share via


GetThemeDocumentationProperty, fonction (uxtheme.h)

Récupère la valeur d’une propriété de thème à partir de la section de documentation du fichier de thème spécifié.

Syntaxe

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

Paramètres

[in] pszThemeName

Type : LPCWSTR

Pointeur vers une chaîne qui contient le nom du fichier de thème qui sera ouvert pour interroger la propriété.

[in] pszPropertyName

Type : LPCWSTR

Pointeur vers une chaîne qui contient le nom de la propriété de thème à interroger. Il peut s’agir de l’une des valeurs suivantes.

Valeur Signification
SZ_THDOCPROP_DISPLAYNAME
Récupère le nom d’affichage du thème.
SZ_THDOCPROP_TOOLTIP
Récupère l’info-bulle associée à ce thème.
SZ_THDOCPROP_AUTHOR
Récupère le nom de l’auteur du thème.
SZ_THDOCPROP_CANONICALNAME
Récupère le nom du thème.

[out] pszValueBuff

Type : LPWSTR

Pointeur vers une mémoire tampon de chaîne qui reçoit la valeur de chaîne de propriété.

[in] cchMaxValChars

Type : int

Valeur de type int qui spécifie le nombre maximal de caractères que pszValueBuff peut contenir.

Valeur retournée

Type : HRESULT

Si cette fonction réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Si la propriété de thème a été localisée dans la table de chaînes de fichiers de thème, cette fonction retourne la version localisée.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 [applications de bureau uniquement]
Plateforme cible Windows
En-tête uxtheme.h
Bibliothèque UxTheme.lib
DLL UxTheme.dll