FlashWindow

2.x

  BOOL FlashWindow(hwnd, fInvert)    
  HWND hwnd; /* handle of window to flash */
  BOOL fInvert; /* invert flag, */  

The FlashWindow function flashes the given window once. Flashing a window means changing the appearance of its title bar as if the window were changing from inactive to active status or vice versa. (An inactive title bar changes to an active title bar or an active title bar changes to an inactive title bar.)

Typically, a window is flashed to inform the user that the window requires attention but that it does not currently have the input focus.

Parameters

hwnd

Identifies the window to be flashed. The window can be either open or minimized.

fInvert

Specifies whether to flash the window or return it to its original state. If this parameter is TRUE, the window is flashed from one state to the other. If the parameter is FALSE, the window is returned to its original state (either active or inactive).

Return Value

The return value is nonzero if the window was active before the call to the FlashWindow function. Otherwise, it is zero.

Comments

The FlashWindow function flashes the window only once; for successive flashing, the application should create a system timer.

The fInvert parameter should be FALSE only when the window is receiving the input focus and will no longer be flashing; it should be TRUE on successive calls while waiting to get the input focus.

This function always returns nonzero for minimized windows. If the window is minimized, FlashWindow simply flashes the window's icon; fInvert is ignored for minimized windows.

See Also

MessageBeep