Edit

Button_SetState macro (windowsx.h)

  • Article

Sets the highlight state of a button. The highlight state indicates whether the button is highlighted as if the user had pushed it. You can use this macro or send the BM_SETSTATE message explicitly.

Syntax

void Button_SetState(
   hwndCtl,
   state
);

Parameters

hwndCtl

Type: HWND

A handle to the button control.

state

Type: BOOL

TRUE to highlight the button; otherwise FALSE.

Return value

None

Remarks

Highlighting affects only the appearance of a button. It has no effect on the check state of a radio button or check box.

A button is automatically highlighted when the user positions the cursor over it and presses and holds the left mouse button. The highlighting is removed when the user releases the mouse button.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header windowsx.h