CSShowCaret Function

Description

Tests if the caret is shown/or hidden.

Syntax

VB/A 32bits

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

VB/A 64bits

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

Return Value

The return value is always 1 (one), or 0 (zero) if an error occurs.

Parameters

hWnd

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

Remarks

An error occurs only if hWnd is not a valid Consoul window handle. The caret position can be set or queried with the CSGetCaretPos / CSSetCaretPos API functions.