Función SetConsoleOutputCP

Artículo
12/15/2023

Establece la página de códigos de salida usada por la consola asociada al proceso de llamada. Una consola usa su página de códigos de salida para traducir los valores de caracteres escritos por las distintas funciones de salida en las imágenes mostradas en la ventana de la consola.

Sintaxis

BOOL WINAPI SetConsoleOutputCP(
  _In_ UINT wCodePageID
);

Parámetros

wCodePageID [in]
El identificador de la página de códigos que se va a establecer. Para obtener más información, vea la sección Comentarios.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Una página de códigos asigna códigos de 256 caracteres a caracteres individuales. Cada página de código incluye caracteres especiales distintos, que suelen estar personalizados para un idioma o grupo de idiomas.

Si el tipo de letra actual es un tipo de letra Unicode de paso fijo, SetConsoleOutputCP cambia la asignación de los valores de carácter en el conjunto de glifos del tipo de letra, en lugar de cargar un tipo de letra independiente cada vez que se llama. Esto afecta a cómo se muestran los caracteres extendidos (valor ASCII mayor que 127) en una ventana de consola. Sin embargo, si el tipo de letra actual es una fuente ráster, SetConsoleOutputCP no afecta a cómo se muestran los caracteres extendidos.

Para buscar las páginas de códigos instaladas o compatibles con el sistema operativo, use la función EnumSystemCodePages. Los identificadores de las páginas de códigos disponibles en el equipo local también se almacenan en el Registro bajo la clave siguiente:

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Nls\CodePage

Sin embargo, es mejor usar EnumSystemCodePages para enumerar páginas de códigos porque el registro puede diferir en distintas versiones de Windows. Para determinar si una página de códigos determinada es válida, use la función IsValidCodePage. Para recuperar más información sobre una página de códigos, incluido su nombre, use la función GetCPInfoEx. Para obtener una lista de identificadores de página de códigos disponibles, consulte Identificadores de página de códigos.

Para determinar la página de códigos de salida actual de una consola, use la función GetConsoleOutputCP. Para establecer y recuperar la página de códigos de entrada de una consola, use las funciones SetConsoleCP y GetConsoleCP.

Requisitos


Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Encabezado	ConsoleApi2.h (a través de WinCon.h, incluido Windows.h)
Biblioteca	Kernel32.lib
Archivo DLL	Kernel32.dll