NvtClearDisplay Function  
 
BOOL WINAPI NvtClearDisplay(
  HDISPLAY hDisplay,  
  UINT nMode  
);

The NvtClearDisplay function clears the specified display, erasing the text and clearing any attributes.

Parameters

hDisplay
Handle to the virtual display.
nMode
Mode which specifies how the display will be cleared. The following values may be used:
Constant Description
NVT_CLEAR_EOS The display is cleared from the current cursor position to the end of the display. The cursor position is not changed.
NVT_CLEAR_TOS The display is cleared from the beginning of the display to the current cursor position. The cursor position is not changed.
NVT_CLEAR_ALL The entire display is cleared and the cursor is repositioned to the upper left corner of the display.

Return Value

If the function succeeds, the return value is non-zero. If the function fails, it returns zero.

Requirements

Client: Requires Windows 7, Windows Vista or Windows XP.
Server: Requires Windows Server 2008 or Windows Server 2003.
Header: Include cstools7.h.
Library: Use csnvtav7.lib.

See Also

NvtDeleteChar, NvtDeleteLine, NvtEraseChar, NvtEraseLine, NvtResetDisplay