Edit

Share via

GetThemeString function (uxtheme.h)

  • Article

Retrieves the value of a string property.

Syntax

HRESULT GetThemeString(
  [in]  HTHEME hTheme,
  [in]  int    iPartId,
  [in]  int    iStateId,
  [in]  int    iPropId,
  [out] LPWSTR pszBuff,
  [in]  int    cchMaxBuffChars
);

Parameters

[in] hTheme

Type: HTHEME

Handle to a window's specified theme data. Use OpenThemeData to create an HTHEME.

[in] iPartId

Type: int

Value of type int that specifies the part containing the string property. See Parts and States.

[in] iStateId

Type: int

Value of type int that specifies the state of the part. See Parts and States.

[in] iPropId

Type: int

Value of type int that specifies the property to retrieve. For a list of possible values, see Property Identifiers.

[out] pszBuff

Type: LPWSTR

Pointer to a buffer that receives the string value.

[in] cchMaxBuffChars

Type: int

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

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

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

See also

Property Identifiers