Função GetCPInfoExA (winnls.h)

Artigo
08/27/2023

Recupera informações sobre qualquer página de código instalada ou disponível válida.

Sintaxe

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

Parâmetros

[in] CodePage

Identificador da página de código para a qual recuperar informações. O aplicativo pode especificar o identificador de página de código para qualquer página de código instalada ou disponível ou um dos valores predefinidos a seguir. Consulte Identificadores de Página de Código para obter uma lista de identificadores para ANSI e outras páginas de código.

Valor	Significado
CP_ACP	Use a página de código ANSI do Windows padrão do sistema.
CP_MACCP	Use a página de código padrão do Macintosh do sistema.
CP_OEMCP	Use a página de código OEM padrão do sistema.
CP_THREAD_ACP	Use a página de código ANSI do thread atual.

[in] dwFlags

Reservados; deve ser 0.

[out] lpCPInfoEx

Ponteiro para uma estrutura CPINFOEX que recebe informações sobre a página de código.

Retornar valor

Retorna um valor diferente de zero se tiver êxito ou 0 de outra forma. Para obter informações de erro estendidas, o aplicativo pode chamar GetLastError, que pode retornar um dos seguintes códigos de erro:

ERROR_INVALID_PARAMETER. Qualquer um dos valores de parâmetro era inválido.

Comentários

As informações recuperadas na estrutura CPINFOEX nem sempre são úteis para todas as páginas de código. Para determinar tamanhos de buffer, por exemplo, o aplicativo deve chamar MultiByteToWideChar ou WideCharToMultiByte para solicitar um tamanho de buffer preciso. Se as configurações de CPINFOEX indicarem que existe um byte de cliente potencial, a função de conversão não necessariamente manipula bytes de lead de forma diferente, por exemplo, no caso de um byte de trilha ausente ou ilegal.

Observação

O cabeçalho winnls.h define GetCPInfoEx como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [aplicativos da área de trabalho \| Aplicativos UWP]
Servidor mínimo com suporte	Windows 2000 Server [aplicativos da área de trabalho \| Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	winnls.h (inclua Windows.h)
Biblioteca	Kernel32.lib
DLL	Kernel32.dll