CSGetCaretWidth Function

Description

Returns the width in pixels of the caret. The default width of the caret is CSGetCharWidth.

Syntax

VB/A 32bits

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

VB/A 64bits

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

Return Value

The return value is the caret width, in pixels, or zero if hWnd is not a valid Consoul window handle.

Parameters

hWnd

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