GetThemeDocumentationProperty-Funktion (uxtheme.h)

Artikel
03/03/2024

Ruft den Wert für eine Designeigenschaft aus dem Dokumentationsabschnitt der angegebenen Designdatei ab.

Syntax

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

Parameter

[in] pszThemeName

Typ: LPCWSTR

Zeiger auf eine Zeichenfolge, die den Namen der Designdatei enthält, die geöffnet wird, um die Eigenschaft abzufragen.

[in] pszPropertyName

Typ: LPCWSTR

Zeiger auf eine Zeichenfolge, die den Namen der abzufragenden Designeigenschaft enthält. Dies kann einer der folgenden Werte sein.

Wert	Bedeutung
SZ_THDOCPROP_DISPLAYNAME	Ruft den Anzeigenamen des Designs ab.
SZ_THDOCPROP_TOOLTIP	Ruft die QuickInfo ab, die diesem Design zugeordnet ist.
SZ_THDOCPROP_AUTHOR	Ruft den Namen des Autors des Designs ab.
SZ_THDOCPROP_CANONICALNAME	Ruft den Namen des Designs ab.

[out] pszValueBuff

Typ: LPWSTR

Zeiger auf einen Zeichenfolgenpuffer, der den Wert der Eigenschaftszeichenfolge empfängt.

[in] cchMaxValChars

Typ: int

Der Wert vom Typ int , der die maximale Anzahl von Zeichen angibt, die pszValueBuff enthalten kann.

Rückgabewert

Typ: HRESULT

Wenn diese Funktion erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Wenn die Designeigenschaft in der Zeichenfolgentabelle der Designdateien lokalisiert wurde, gibt diese Funktion die lokalisierte Version zurück.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	uxtheme.h
Bibliothek	UxTheme.lib
DLL	UxTheme.dll