GetCPInfo function (winnls.h)

Article
02/22/2024

Retrieves information about any valid installed or available code page.

Note To obtain additional information about valid installed or available code pages, the application should use GetCPInfoEx.

Syntax

BOOL GetCPInfo(
  [in]  UINT     CodePage,
  [out] LPCPINFO lpCPInfo
);

Parameters

[in] CodePage

Identifier for the code page for which to retrieve information. For details, see the CodePage parameter of GetCPInfoEx.

[out] lpCPInfo

Pointer to a CPINFO structure that receives information about the code page. See the Remarks section.

Return value

Returns 1 if successful, or 0 otherwise. To get extended error information, the application can call GetLastError, which can return one of the following error codes:

ERROR_INVALID_PARAMETER. Any of the parameter values was invalid.

Remarks

See Remarks for GetCPInfoEx.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps \| UWP apps]
Minimum supported server	Windows 2000 Server [desktop apps \| UWP apps]
Target Platform	Windows
Header	winnls.h (include Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll