SetConsoleCursorPosition
The SetConsoleCursorPosition
function sets the cursor position in the specified console screen buffer.
BOOL SetConsoleCursorPosition(
|
HANDLE hConsoleOutput, |
// handle of
console screen buffer |
|
COORD dwCursorPosition |
// new cursor
position coordinates |
|
); |
|
Parameters
hConsoleOutput
Identifies a
console screen buffer. The handle must have GENERIC_WRITE access.
dwCursorPosition
Specifies a COORD structure containing the
new cursor position. The coordinates are the column and row of a screen buffer
character cell. The coordinates must be within the boundaries of the screen
buffer.
Return Values
If the
function succeeds, the return value is nonzero.
If the
function fails, the return value is zero. To get extended error information,
call GetLastError.
Remarks
The cursor
position determines where characters written by the WriteFile or WriteConsole
function, or echoed by the ReadFile or ReadConsole function, are
displayed. To determine the current position of the cursor, use the GetConsoleScreenBufferInfo
function.
If the new
cursor position is not within the boundaries of the screen buffer s window, the
window origin changes to make the cursor visible.
See Also