Функция GetCPInfoExA (winnls.h)

Статья
03/04/2024

Извлекает сведения о любой допустимой установленной или доступной кодовой странице.

Синтаксис

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

Параметры

[in] CodePage

Идентификатор кодовой страницы, для которой требуется получить сведения. Приложение может указать идентификатор кодовой страницы для любой установленной или доступной кодовой страницы или одно из следующих предопределенных значений. Список идентификаторов для ANSI и других кодовых страниц см. в разделе Идентификаторы кодовых страниц.

Значение	Значение
CP_ACP	Используйте системную кодовую страницу Windows ANSI по умолчанию.
CP_MACCP	Используйте системную кодовую страницу Macintosh по умолчанию.
CP_OEMCP	Используйте системную кодовую страницу OEM по умолчанию.
CP_THREAD_ACP	Используйте кодовую страницу ANSI текущего потока.

[in] dwFlags

Защищены; значение должно иметь значение 0.

[out] lpCPInfoEx

Указатель на структуру CPINFOEX , которая получает сведения о кодовой странице.

Возвращаемое значение

Возвращает ненулевое значение в случае успешного выполнения или значение 0 в противном случае. Чтобы получить расширенные сведения об ошибке, приложение может вызвать Метод GetLastError, который может возвращать один из следующих кодов ошибок:

ERROR_INVALID_PARAMETER. Любое из значений параметров было недопустимым.

Сведения, полученные в структуре CPINFOEX , не всегда полезны для всех кодовых страниц. Например, чтобы определить размер буфера, приложение должно вызвать MultiByteToWideChar или WideCharToMultiByte , чтобы запросить точный размер буфера. Если параметры CPINFOEX указывают на существование байта свинца, функция преобразования не обязательно обрабатывает байты свинца по-другому, например в случае отсутствия или незаконного байта следа.

Примечание

Заголовок winnls.h определяет GetCPInfoEx как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Профессиональная [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows 2000 Server [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	winnls.h (включая Windows.h)
Библиотека	Kernel32.lib
DLL	Kernel32.dll