Edit

Share via


GetConsoleCP function

Retrieves the input code page used by the console associated with the calling process. A console uses its input code page to translate keyboard input into the corresponding character value.

Syntax

UINT WINAPI GetConsoleCP(void);

Parameters

This function has no parameters.

Return value

The return value is a code that identifies the code page. For a list of identifiers, see Code Page Identifiers.

If the return value is zero, the function has failed. To get extended error information, call GetLastError.

Remarks

A code page maps 256 character codes to individual characters. Different code pages include different special characters, typically customized for a language or a group of languages. To retrieve more information about a code page, including it's name, see the GetCPInfoEx function.

To set a console's input code page, use the SetConsoleCP function. To set and query a console's output code page, use the SetConsoleOutputCP and GetConsoleOutputCP functions.

Requirements

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

See also

Console Code Pages

Console Functions

GetConsoleOutputCP

SetConsoleCP

SetConsoleOutputCP