CSGetCaretHeight Function

Description

Returns the height in pixels of the caret. The default height of the caret is CSGetLineHeight().

Syntax

VB/A 32bits

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

VB/A 64bits

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

Return Value

The return value is the height of the caret, 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.

Remarks

The caret rectangle grows up from the bottom of the caret cell.