CSSetLinePadding Function

Description

The line padding is an area that can be added to the top or the bottom of the console lines. It site between the character cell and the line spacing. The padding doesn't grow (or shrink) the line height.

When the height of the padding is positive for the top, the text is pushed down the line. When it's positive for the botton, the character cell grows down.

When the height of the padding is negative for the top, the text is pulled up then line. When it's negative for the bottom, the character cell shrinks up.

Syntax

VB/A 32bits

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

VB/A 64bits

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

Return Value

The return value has no particular meaning.

Parameters

hWnd

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

wSpacing

The height in pixels of the line padding to add either on the top of the line if wTopOrBottom is 0 (zero), or on the bottom of the line if wTopOrBottom is 1 (one) or not zero.

wTopOrBottom

0 (zero) to add padding to the top of the character cell, 1 (one) or any other non zero value to add padding to the botton of the character cell.

Remarks

See also Line Height, CSGetLineSpacing, CSGetLinePadding and CSSetLineSpacing.