Permalink
Fetching contributors…
Cannot retrieve contributors at this time
119 lines (90 sloc) 2.87 KB
title description author ms.author ms.topic ms.prod keywords MS-HAID MSHAttr ms.assetid topic_type api_name api_location api_type
GetConsoleOutputCP function
Retrieves the output code page used by the console associated with the calling process.
bitcrazed
richturn
article
console
console, character mode applications, command line applications, terminal applications, console api
\_win32\_getconsoleoutputcp
base.getconsoleoutputcp
consoles.getconsoleoutputcp
PreferredSiteName:MSDN
PreferredLib:/library/windows/desktop
c23706c7-ce17-4825-a494-20ca44534d45
apiref
GetConsoleOutputCP
Kernel32.dll
API-MS-Win-Core-Console-l1-1-0.dll
KernelBase.dll
API-MS-Win-DownLevel-Kernel32-l1-1-0.dll
MinKernelBase.dll
DllExport

GetConsoleOutputCP function

Retrieves the output code page used by the console associated with the calling process. A console uses its output code page to translate the character values written by the various output functions into the images displayed in the console window.

Syntax

UINT WINAPI GetConsoleOutputCP(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.

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 output code page, use the SetConsoleOutputCP function. To set and query a console's input code page, use the SetConsoleCP and GetConsoleCP 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 Code Pages

Console Functions

GetConsoleCP

SetConsoleCP

SetConsoleOutputCP