CSClear Function

Description

Removes all the lines from the window's output queue and refreshes the window's display (which will be empty). A subsequent call to LQGetCount for the same window will return 0 (zero) after this call.

Syntax

VB/A 32bits

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

VB/A 64bits

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

Return Value

The return value is 1 (one) if the queue is cleared, or 0 (zero) if hWnd is not a Consoul window handle.

Parameters

hWnd

A valid Consoul window handle.

Remarks

If you're operating a console in virtual mode, you may consider using CSResetAllLines instead.