BOOL Clear( |
|
UINT nMode |
|
); |
The Clear method clears the specified display, erasing the
text and clearing any attributes.
Parameters
- 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 method succeeds, the return value is non-zero. If the
method fails, it returns zero.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: csnvtv10.lib
See Also
DeleteChar,
DeleteLine,
EraseChar,
EraseLine, Reset
|