Permalink
Fetching contributors…
Cannot retrieve contributors at this time
140 lines (103 sloc) 3.71 KB
title description author ms.author ms.topic ms.prod keywords MS-HAID MSHAttr ms.assetid topic_type api_name api_location api_type
SetConsoleCursorPosition function
Sets the cursor position in the specified console screen buffer.
bitcrazed
richturn
article
console
console, character mode applications, command line applications, terminal applications, console api
\_win32\_setconsolecursorposition
base.setconsolecursorposition
consoles.setconsolecursorposition
PreferredSiteName:MSDN
PreferredLib:/library/windows/desktop
8e9abada-a64e-429f-8286-ced1169c7104
apiref
SetConsoleCursorPosition
Kernel32.dll
API-MS-Win-Core-Console-l2-1-0.dll
KernelBase.dll
API-MS-Win-DownLevel-Kernel32-l1-1-0.dll
DllExport

SetConsoleCursorPosition function

Sets the cursor position in the specified console screen buffer.

Syntax

BOOL WINAPI SetConsoleCursorPosition(
  _In_ HANDLE hConsoleOutput,
  _In_ COORD  dwCursorPosition
);

Parameters

hConsoleOutput [in]
A handle to the console screen buffer. The handle must have the GENERIC_READ access right. For more information, see Console Buffer Security and Access Rights.

dwCursorPosition [in]
A COORD structure that specifies the new cursor position, in characters. The coordinates are the column and row of a screen buffer character cell. The coordinates must be within the boundaries of the console screen buffer.

Return value

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 console screen buffer's window, the window origin changes to make the cursor visible.

Examples

For an example, see Using the High-Level Input and Output Functions.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Wincon.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

Console Functions

Console Screen Buffers

GetConsoleCursorInfo

GetConsoleScreenBufferInfo

ReadConsole

ReadFile

SetConsoleCursorInfo

WriteConsole

WriteFile