GetLocaleInfo
The GetLocaleInfo
function retrieves information about a locale.
int GetLocaleInfo(
|
LCID Locale, |
// locale
identifier |
|
LCTYPE LCType, |
// type of
information |
|
LPTSTR lpLCData, |
// address of
buffer for information |
|
int cchData |
// size of buffer |
|
); |
|
Parameters
Locale
Specifies the
locale to retrieve information for. This parameter can be a locale identifier
created by the MAKELCID
macro, or one of the following predefined values:
|
LOCALE_SYSTEM_DEFAULT |
Default
system locale. |
|
LOCALE_USER_DEFAULT |
Default
user locale. |
LCType
Specifies one
of the LCTYPE constants to indicate the type of information to be
retrieved.
All LCTYPE
values are mutually exclusive, with the exception of LOCALE_NOUSEROVERRIDE.
An application may use the binary-OR operator to combine LOCALE_NOUSEROVERRIDE
with any other LCTYPE value. If passed such an LCType value, the
function bypasses user overrides, and returns the system default value for the
requested LCID.
lpLCData
Points to a
buffer to receive the requested data.
cchData
Specifies the
size, in bytes (ANSI version) or characters (Unicode version), of the lpLCData
buffer. If cchData is zero, the function returns the number of bytes or
characters required to hold the information, and the buffer pointed to by lpLCData
is not used.
Return Values
If the
function succeeds, the return value is the number of bytes (ANSI version) or
characters (Unicode version) written to the destination buffer, or if the cchData
parameter is zero, the number of bytes or characters required to hold the
locale information.
If the
function fails, the return value is zero. To get extended error information,
call GetLastError.
GetLastError may return one of the following error codes:
|
ERROR_INSUFFICIENT_BUFFER |
|
ERROR_INVALID_FLAGS |
|
ERROR_INVALID_PARAMETER |
Remarks
The GetLocaleInfo
function always retrieves information in text format. If the information is a
numeric value, the function converts the number to text using decimal notation.
See Also