GetThemeString function

Retrieves the value of a string property.

Syntax

THEMEAPI GetThemeString(
  HTHEME hTheme,
  int    iPartId,
  int    iStateId,
  int    iPropId,
  LPWSTR pszBuff,
  int    cchMaxBuffChars
);

Parameters

hTheme

Type: HTHEME

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

iPartId

Type: int

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

iStateId

Type: int

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

iPropId

Type: int

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

pszBuff

Type: LPWSTR

Pointer to a buffer that receives the string value.

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

   
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