CTerminalEmulator::EraseLine Method  
 
BOOL EraseLine(
  UINT nMode  
);

The EraseLine method erases the current line without affecting the lines that follow.

Parameters

nMode
Mode which specifies how the line will be erased. The following values may be used:
Value Description
0 The line is erased from the current cursor position to the end of the line.
1 The line is cleared from the beginning of the line to the current cursor position.
2 The entire line is cleared.

Return Value

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

Remarks

This method does not change the current cursor position. To delete a line from the display and shift the remaining lines up, use the DeleteLine method.

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
Unicode: Implemented as Unicode and ANSI versions.

See Also

Clear, DeleteChar, DeleteLine, EraseChar