getconsoleselectioninfo.md

title	description	author	ms.author	ms.topic	keywords	f1_keywords	MS-HAID	MSHAttr	ms.assetid	topic_type	api_name	api_location	api_type
GetConsoleSelectionInfo function	See reference information about the GetConsoleSelectionInfo function, which retrieves information about the current console selection.	miniksa	miniksa	article	console, character mode applications, command line applications, terminal applications, console api	consoleapi3/GetConsoleSelectionInfo wincon/GetConsoleSelectionInfo GetConsoleSelectionInfo	\_win32\_getconsoleselectioninfo base.getconsoleselectioninfo consoles.getconsoleselectioninfo	PreferredSiteName:MSDN PreferredLib:/library/windows/desktop	912efe9d-75dd-43bd-8dca-08671b5ed79c	apiref	GetConsoleSelectionInfo	Kernel32.dll	DllExport

GetConsoleSelectionInfo function

[!INCLUDE not-recommended-banner]

Retrieves information about the current console selection.

Syntax

BOOL WINAPI GetConsoleSelectionInfo(
  _Out_ PCONSOLE_SELECTION_INFO lpConsoleSelectionInfo
);

Parameters

lpConsoleSelectionInfo [out]
A pointer to a CONSOLE_SELECTION_INFO structure that receives the selection information.

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

To compile an application that uses this function, define _WIN32_WINNT as 0x0500 or later. For more information, see Using the Windows Headers.

[!INCLUDE no-vt-equiv-user-priv]

Requirements

Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Header	ConsoleApi3.h (via WinCon.h, include Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll

See also

Console Functions

Console Selection

CONSOLE_SELECTION_INFO