This function sets the caret blink time to the specified number of milliseconds. The blink time is the elapsed time, in milliseconds, required to invert the caret's pixels.

BOOL SetCaretBlinkTime(
UINT uMSeconds);


  • uMSeconds
    [in] Unsigned integer that contains the new blink time in milliseconds.

Return Values

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.


The user can set the blink time using the Control Panel. Applications should respect the setting that the user has chosen. The SetCaretBlinkTime function should only be used by applications that allow the user to set the blink time, such as a Control Panel applet.

Changing the caret blink time in one application does not affect the blink time in subsequently loaded applications.


Runs On Versions Defined in Include Link to
Windows CE OS 1.0 and later Winuser.h   Caret.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also


 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.