Share via

SetCaretBlinkTime (Compact 2013)

  • Article

3/28/2014

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.

Syntax

BOOL SetCaretBlinkTime(
  UINT uMSeconds
);

Parameters

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

Return Value

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

Remarks

The user can set the blink time using 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 program.

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

Requirements

Header

winuser.h

Library

Caret.lib

See Also

Reference

Caret Functions
GetCaretBlinkTime