CSGetLineSpacing Function

Description

Gets the spacing value in pixels that is applied to a Consoul window line. Spacing can be applied at the top or at the bottom of each line with the CSSetLineSpacing API function.

Syntax

VB/A 32bits

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

VB/A 64bits

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

Return Value

The return value, depending on wTopOrBottom, is the top or bottom spacing applied to all of the console lines.

Parameters

hWnd

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

wTopOrBottom

Either 0 (zero) to get the spacing applied to the top of the console lines, or 1 (one) for the bottom spacing.

Remarks

Spacing values can be negative.

  • When the top spacing is negative, the output of the line will be pulled up, but will not overflow on the preceding line, as the output is clipped to the drawing rectangle (drawing rectangle).
  • When the bottom spacing is negative, the bottom of the line will be cut by the bottom spacing value.
Last updated: May 13 2022.