SetConsoleCursorInfo

BOOL SetConsoleCursorInfo(hConsoleOutput, pcci)
HANDLE hConsoleOutput;	/* identifies the screen buffer	*/
PCONSOLE_CURSOR_INFO pcci;	/* address of cursor information	*/

The SetConsoleCursorInfo function sets the size and visibility of the cursor for the specified console screen buffer.

Parameters

hConsoleOutput

Specifies an open handle with GENERIC_WRITE access to a console screen buffer.

pcci

Points to a CONSOLE_CURSOR_INFO structure containing the new specifications for the screen buffer's cursor.

The CONSOLE_CURSOR_INFO structure has the following form:

typedef struct _CONSOLE_CURSOR_INFO { /* cci */

DWORD dwSize;

BOOL bVisible;

} CONSOLE_CURSOR_INFO, *PCONSOLE_CURSOR_INFO;

Return Value

The return value is TRUE if the function was successful, or FALSE if an error occurred. Use the GetLastError function to obtain extended error information.

Comments

The SetConsoleCursorInfo function will fail if pcci->dwSize is less than 1 or greater than 100.