CSPopLines Function

Description

Tries to pop as many lines as asked from the Consoul window queue.

Syntax

VB/A 32bits

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

VB/A 64bits

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

Return Value

The return value is the number of popped lines.

Parameters

hWnd

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

wPopCount

The number of lines that should be popped out of the queue.

Remarks

Consoul will try to pop as many lines as asked, count the lines it pops out and stop popping if there are no more lines to pop.