GetCaretBlinkTime function (winuser.h)

Retrieves the time required to invert the caret's pixels. The user can set this value.

Syntax

UINT GetCaretBlinkTime();

Parameters

This function has no parameters.

Return value

Type: UINT

If the function succeeds, the return value is the blink time, in milliseconds.

A return value of INFINITE indicates that the caret does not blink.

A return value is zero indicates that the function has failed. To get extended error information, call GetLastError.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header winuser.h (include Windows.h)
Library User32.lib
DLL User32.dll
API set ext-ms-win-ntuser-caret-l1-1-0 (introduced in Windows 8)

See also

Carets

Conceptual

Reference

SetCaretBlinkTime