GetThemeStream function

Retrieves a data stream corresponding to a specified theme, starting from a specified part, state, and property.

Syntax

HRESULT GetThemeStream(
  _In_   HTHEME hTheme,
  _In_   int iPartId,
  _In_   int iStateId,
  _In_   int iPropId,
  _Out_  VOID **ppvStream,
  _Out_  DWORD *pcbStream,
  _In_   HINSTANCE hInst
);

Parameters

hTheme [in]

Type: HTHEME

Handle to the theme from which the stream will be retrieved.

iPartId [in]

Type: int

Specifies the part to retrieve a stream from. See Parts and States.

iStateId [in]

Type: int

Specifies the state of the part.

iPropId [in]

Type: int

Specifies the property to retrieve.

ppvStream [out]

Type: VOID**

Address of a pointer that receives the stream.

pcbStream [out]

Type: DWORD*

Pointer that receives the length, in bytes, of the stream received by ppvStream.

hInst [in]

Type: HINSTANCE

If iPropId is TMT_STREAM, this value is NULL. If iPropId is TMT_DISKSTREAM, this value is the HINSTANCE of a loaded styles file.

Return value

Type: HRESULT

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

Remarks

Windows 8: In high contrast mode, the data stream retrieved by this function is not valid after the hTheme theme handle is closed.

The data stream retrieved by this function is not a copy; do not delete or close the data stream after using it.

Requirements

See also

Parts and States

Send comments about this topic to Microsoft

Build date: 10/27/2012