CSGetCaretBlinkMs Function

Description

Returns the number of milliseconds between each caret state (visible/hidden) that makes the caret blink.

Syntax

VB/A 32bits

Private Declare Function CSGetCaretBlinkMs Lib "consoul_010205_32.dll" ( _
  ByVal hWnd As Long _
) As Integer

VB/A 64bits

Private Declare PtrSafe Function CSGetCaretBlinkMs Lib "consoul_010205_64.dll" ( _
  ByVal hWnd As LongPtr _
) As Integer

Return Value

The return value is the current caret blinking time. When 0 (zero) is returned, it's either because the previous caret blinking time was 0 (zero), ie it was not blinking, or because hWnd is not a valid Consoul window handle; there's actually no ways of distinguishing both meanings.

Parameters

hWnd

The window handle (HWND) of the Consoul window, as returned by CSCreateLogWindow.