NvtClearDisplay
BOOL NvtClearDisplay(
HDISPLAY hDisplay,  
UINT fuMode  
);

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

Parameters

hDisplay
Handle to the virtual display.
fuMode
Mode which specifies how the display is to 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 Vista, Windows XP or Windows 2000 Professional.
Server: Requires Windows Server 2008, Windows Server 2003 or Windows 2000 Server.
Header: Include cstools6.h.
Library: Use csnvtav6.lib.

See Also

NvtDeleteChar, NvtDeleteLine, NvtEraseChar, NvtEraseLine, NvtResetDisplay


Copyright © 2008 Catalyst Development Corporation. All rights reserved.