nf-uxtheme-getthemedocumentationproperty.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:uxtheme.GetThemeDocumentationProperty	GetThemeDocumentationProperty function (uxtheme.h)	Retrieves the value for a theme property from the documentation section of the specified theme file.	GetThemeDocumentationProperty GetThemeDocumentationProperty function [Windows Controls] SZ_THDOCPROP_AUTHOR SZ_THDOCPROP_CANONICALNAME SZ_THDOCPROP_DISPLAYNAME SZ_THDOCPROP_TOOLTIP controls.GetThemeDocumentationProperty controls.inet_GetThemeDocumentationProperty inet_GetThemeDocumentationProperty inet_GetThemeDocumentationProperty_cpp uxtheme/GetThemeDocumentationProperty	controls\GetThemeDocumentationProperty.htm	Controls	VS|Controls|~\controls\userex\functions\getthemedocumentationproperty.htm	12/05/2018	GetThemeDocumentationProperty, GetThemeDocumentationProperty function [Windows Controls], SZ_THDOCPROP_AUTHOR, SZ_THDOCPROP_CANONICALNAME, SZ_THDOCPROP_DISPLAYNAME, SZ_THDOCPROP_TOOLTIP, controls.GetThemeDocumentationProperty, controls.inet_GetThemeDocumentationProperty, inet_GetThemeDocumentationProperty, inet_GetThemeDocumentationProperty_cpp, uxtheme/GetThemeDocumentationProperty	uxtheme.h		Windows	Windows Vista [desktop apps only]	Windows Server 2003 [desktop apps only]										UxTheme.lib	UxTheme.dll		Windows			19H1	GetThemeDocumentationProperty uxtheme/GetThemeDocumentationProperty	c++	APIRef kbSyntax	DllExport	UxTheme.dll	GetThemeDocumentationProperty

GetThemeDocumentationProperty function

-description

Retrieves the value for a theme property from the documentation section of the specified theme file.

-parameters

-param pszThemeName [in]

Type: LPCWSTR

Pointer to a string that contains the name of the theme file that will be opened to query for the property.

-param pszPropertyName [in]

Type: LPCWSTR

Pointer to a string that contains the name of the theme property to query. Can be one of the following values.

Value	Meaning
SZ_THDOCPROP_DISPLAYNAME	Retrieves the display name of the theme.
SZ_THDOCPROP_TOOLTIP	Retrieves the tooltip associated with this theme.
SZ_THDOCPROP_AUTHOR	Retrieves the name of the author of the theme.
SZ_THDOCPROP_CANONICALNAME	Retrieves the name of the theme.

-param pszValueBuff [out]

Type: LPWSTR

Pointer to a string buffer that receives the property string value.

-param cchMaxValChars [in]

Type: int

Value of type int that specifies the maximum number of characters that pszValueBuff can contain.

-returns

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.