This topic has not yet been rated - Rate this topic

HitTestThemeBackground function

Retrieves a hit test code for a point in the background specified by a visual style.

Syntax


HRESULT HitTestThemeBackground(
  _In_   HTHEME hTheme,
  _In_   HDC hdc,
  _In_   int iPartId,
  _In_   int iStateId,
  _In_   DWORD dwOptions,
  _In_   LPCRECT pRect,
  _In_   HRGN hrgn,
  _In_   POINT ptTest,
  _Out_  WORD *pwHitTestCode
);

Parameters

hTheme [in]

Type: HTHEME

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

hdc [in]

Type: HDC

HDC to use when drawing. This parameter may be set to NULL.

iPartId [in]

Type: int

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

iStateId [in]

Type: int

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

dwOptions [in]

Type: DWORD

DWORD that specifies the hit test options. See Hit Test Options for a list of options.

pRect [in]

Type: LPCRECT

Pointer to a RECT structure that contains, in logical coordinates, the rectangle that bounds the background.

hrgn [in]

Type: HRGN

Handle to a region that can be used to specify the bounds of a hit test area. This parameter may be set to NULL.

ptTest [in]

Type: POINT

POINT structure that contains the coordinates of the point.

pwHitTestCode [out]

Type: WORD*

WORD that receives the hit test code that indicates whether the point in ptTest is in the background area bounded by pRect or hrgn. See Hit Test Return Values for a list of values returned.

Return value

Type: HRESULT

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

Remarks

The values in ptTest and pRect should be in the same coordinate system, such as client or screen. If the hrgn parameter is used, it must be specified in the same coordinates as pRect and ptTest.

Requirements

Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Header	Uxtheme.h
Library	UxTheme.lib
DLL	UxTheme.dll

Community Additions

ADD