GBM_QUERYSTATE

This message returns the current state of the graphic button.

Syntax

param1
     [[ULONG]]   [[ulReserved]]  /*  Reserved. */

param2
     [[ULONG]]   [[ulReserved]]  /*  Reserved. */

Parameters

ulReserved (ULONG): Reserved.

ulReserved (ULONG): Reserved.

Return Value

rc (ULONG)

Return codes indicating the state of the graphic button.

GB_UP: The graphic button is in the Up state.
GB_DOWN: The graphic button is in the Down state.
GB_HILITE: The graphic button is in the highlighted state.
GB_ERROR: An error has occurred.

Remarks

Graphic buttons that are not of either GBS_TWOSTATE or GBS_AUTOTWOSTATE styles always are considered in the Up state.

Animation can occur independently from a change in state of the button. The drawing of animation bitmaps takes precedence over the current state bitmap.

A multi-state button or a button that draws bitmaps in its highlighted or disabled states is not intended to be animated, and animated buttons are not intended to have visual states. The combination of these two styles might yield undefined results.