Función GetCPInfoExA (winnls.h)

Artículo
08/27/2023

Recupera información sobre cualquier página de códigos válida instalada o disponible.

Sintaxis

BOOL GetCPInfoExA(
  [in]  UINT        CodePage,
  [in]  DWORD       dwFlags,
  [out] LPCPINFOEXA lpCPInfoEx
);

Parámetros

[in] CodePage

Identificador de la página de códigos para la que se va a recuperar información. La aplicación puede especificar el identificador de página de códigos para cualquier página de códigos instalada o disponible, o uno de los siguientes valores predefinidos. Consulte Identificadores de página de códigos para obtener una lista de identificadores para ANSI y otras páginas de códigos.

Valor	Significado
CP_ACP	Use la página de códigos ANSI de Windows predeterminada del sistema.
CP_MACCP	Use la página de códigos de Macintosh predeterminada del sistema.
CP_OEMCP	Use la página de códigos oem predeterminada del sistema.
CP_THREAD_ACP	Use la página de códigos ANSI del subproceso actual.

[in] dwFlags

Reservados; debe ser 0.

[out] lpCPInfoEx

Puntero a una estructura CPINFOEX que recibe información sobre la página de códigos.

Valor devuelto

Devuelve un valor distinto de cero si se ejecuta correctamente o 0 de lo contrario. Para obtener información de error extendida, la aplicación puede llamar a GetLastError, que puede devolver uno de los siguientes códigos de error:

ERROR_INVALID_PARAMETER. Cualquiera de los valores de parámetro no era válido.

Comentarios

La información recuperada en la estructura CPINFOEX no siempre es útil para todas las páginas de códigos. Para determinar los tamaños de búfer, por ejemplo, la aplicación debe llamar a MultiByteToWideChar o WideCharToMultiByte para solicitar un tamaño de búfer preciso. Si la configuración de CPINFOEX indica que existe un byte de cliente potencial, la función de conversión no controla necesariamente bytes de cliente potencial de forma diferente, por ejemplo, en el caso de un byte final que falta o no es válido.

Nota

El encabezado winnls.h define GetCPInfoEx como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [aplicaciones de escritorio \| Aplicaciones para UWP]
Servidor mínimo compatible	Windows 2000 Server [aplicaciones de escritorio \| Aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	winnls.h (incluya Windows.h)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll