GetThemeDocumentationProperty function (uxtheme.h)
Retrieves the value for a theme property from the documentation section of the specified theme file.
Syntax
HRESULT GetThemeDocumentationProperty(
[in] LPCWSTR pszThemeName,
[in] LPCWSTR pszPropertyName,
[out] LPWSTR pszValueBuff,
[in] int cchMaxValChars
);
Parameters
[in] pszThemeName
Type: LPCWSTR
Pointer to a string that contains the name of the theme file that will be opened to query for the property.
[in] pszPropertyName
Type: LPCWSTR
Pointer to a string that contains the name of the theme property to query. Can be one of the following values.
[out] pszValueBuff
Type: LPWSTR
Pointer to a string buffer that receives the property string value.
[in] cchMaxValChars
Type: int
Value of type int that specifies the maximum number of characters that pszValueBuff can contain.
Return value
Type: HRESULT
If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Remarks
If the theme property has been localized in the theme files string table, this function returns the localized version.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows Vista [desktop apps only] |
Minimum supported server | Windows Server 2003 [desktop apps only] |
Target Platform | Windows |
Header | uxtheme.h |
Library | UxTheme.lib |
DLL | UxTheme.dll |