Função SetConsoleOutputCP

Artigo
12/15/2023

Define a página de código de saída usada pelo console associado ao processo de chamada. Um console usa sua página de código de saída para converter os valores de caracteres gravados pelas várias funções de saída nas imagens exibidas na janela do console.

Sintaxe

BOOL WINAPI SetConsoleOutputCP(
  _In_ UINT wCodePageID
);

Parâmetros

wCodePageID [entrada]
O identificador da página de código para definir. Para obter mais informações, consulte Comentários.

Valor retornado

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

Uma página de código mapeia códigos de 256 caracteres para caracteres individuais. Diferentes páginas de código contêm caracteres especiais diferentes, que geralmente são personalizados para um idioma ou um grupo de idiomas.

Se a fonte atual for uma fonte Unicode de tom fixo, SetConsoleOutputCP alterará o mapeamento dos valores de caractere no conjunto de glifos da fonte, em vez de carregar uma fonte separada todas as vezes que ela for chamada. Isso afeta como os caracteres estendidos (valor ASCII maior que 127) são exibidos em uma janela do console. No entanto, se a fonte atual for uma fonte de varredura, SetConsoleOutputCP não afetará como os caracteres estendidos são exibidos.

Para localizar as páginas de código que são instaladas ou suportadas pelo sistema operacional, use a função EnumSystemCodePages. Os identificadores das páginas de código disponíveis no computador local também são armazenados no registro sob a seguinte chave:

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Nls\CodePage

No entanto, é melhor usar EnumSystemCodePages para enumerar páginas de código porque o registro pode ser diferente em versões distintas do Windows. Para determinar se uma página de código específica é válida, use a função IsValidCodePage. Para recuperar mais informações sobre uma página de código, incluindo seu nome, use a função GetCPInfoEx. Para obter uma lista de identificadores de página de código disponíveis, consulte Identificadores de página de código.

Para determinar a página de código de saída atual de um console, use a função GetConsoleOutputCP. Para definir e recuperar a página de código de entrada de um console, use as funções SetConsoleCP e GetConsoleCP.

Requisitos


Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Cabeçalho	ConsoleApi2.h (via WinCon.h, inclui o Windows.h)
Biblioteca	Kernel32.lib
DLL	Kernel32.dll