GBM_SETBITMAPINDEX

This message sets the bitmap index to use during various states of the graphic button.

Syntax

param1
     [[USHORT]]  [[usGBState]]   /*  State of graphic button whose index is to be changed. */

param2
     [[USHORT]]  [[usFrameCode]] /*  Frame code. */

Parameters

usGBState (USHORT)

State of graphic button whose index is to be changed.

• GB_UP: Set the bitmap used when in the Up state.
• GB_DOWN: Set the bitmap used when in the Down state.
• GB_HILITE: Set the bitmap used when in the highlighted state.
• GB_DISABLE: Set the bitmap used when in the disabled state.
• GB_ANIMATIONBEGIN: Where animation must begin.
• GB_ANIMATIONEND: Where animation must end.
• GB_CURRENTSTATE: Refers to either up or down bitmaps; depends on whether the button is in the Up or Down state.

usFrameCode (USHORT)

Frame code.

• GB_INDEX_FORWARD: Advance to next bitmap index in circular array.
• GB_INDEX_BACKWARD: Set to previous bitmap index in circular array.
• GB_INDEX_FIRST: Set to first bitmap index.
• GB_INDEX_LAST: Set to last bitmap index.
• desired_bit_map: Otherwise, use usFrameCode number as the bitmap index.

Return Value

rc (ULONG)

The return code indicating success or failure.

• TRUE: Success.
• FALSE: Failure or not recognized.

Remarks

If starting, the animation bit should be less than or equal to the ending animation bitmap index.

Setting the bitmap index for unused states is undefined.