CSGetLinePadding Function

Description

Gets the padding value in pixels that is applied to the characters of a Consoul window line. Padding can be applied at the top or at the bottom of the characters cells of each line with the CSSetLinePadding API function.

Syntax

VB/A 32bits

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

VB/A 64bits

Private Declare PtrSafe Function CSGetLinePadding 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 padding applied to the top of the character cells of the console lines, or 1 (one) for the bottom padding.

Remarks

Padding values can be negative.

• When the top padding is negative, the text blocks be pulled up either inside the line spacing (if there's any) or outside of the (drawing rectangle), 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 characters cells will be cut, leaving the line bottom spacing (if there's any).