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

The NvtEraseLine function erases the current line without affecting the lines that follow.

Parameters

hDisplay
Handle to the virtual display.
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 function succeeds, the return value is non-zero. If the function fails, it returns zero.

Remarks

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

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

See Also

NvtClearDisplay, NvtDeleteChar, NvtDeleteLine, NvtEraseChar