GetThemeBackgroundContentRect Function


This is preliminary documentation and is subject to change.

Retrieves the size of the content area for the theme-defined background.

Syntax

HRESULT GetThemeBackgroundContentRect(
    HTHEME hTheme, 
    int iPartId, 
    int iStateId, 
    const RECT *pBoundingRect, 
    RECT *pContentRect
);

Parameters

hTheme
Handle to a window's specified theme data. Use OpenThemeData to create an HTHEME.
iPartId
Integer that specifies the part containing the content area.
iStateId
Integer that specifies the state of the part containing the content area.
pBoundingRect
Pointer to a RECT structure that contains the total background rectangle, in logical coordinates. This is the area inside the borders or margins.
pContentRect
[out] Pointer to a RECT structure that receives the content area background rectangle, in logical coordinates. This rectangle is calculated to fit the content area.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

A theme can define a content area within each background image. This is the area where content such as text and icons can be placed without overwriting background borders.

Function Information

Stock ImplementationUxTheme.dll
Custom ImplementationNo
HeaderThemeApi.h
Import libraryUxTheme.lib
Minimum operating systems Windows NT Whistler


© 2000 Microsoft Corporation. All rights reserved. Terms of use.