プラットフォーム SDK
GetLocaleInfo
ロケールに関する情報を取得します。
int GetLocaleInfo(
LCID Locale, // ロケール識別子
LCTYPE LCType, // 情報の種類
LPTSTR lpLCData, // 情報を受け取るバッファのアドレス
int cchData // バッファのサイズ
);
パラメータ
- Locale
- 情報を取得するロケールを指定します。MAKELCID マクロによって作成されたロケール識別子か、次のいずれかの定数が指定できます。
| LOCALE_SYSTEM_DEFAULT | 既定のシステムロケール |
| LOCALE_USER_DEFAULT | 既定のユーザーロケール |
- LCType
- 取得する情報の種類を指定する LCTYPE 型定数の 1 つを指定します。
LOCALE_NOUSEROVERRIDE を除き、複数の LCTYPE 型定数を同時に指定することはできません。LOCALE_NOUSEROVERRIDE だけは、2 項 OR 演算子によって他の LCTYPE 型定数を組み合わせて指定することができます。LOCALE_NOUSEROVERRIDE と他の定数を組み合わせた値を指定すると、ユーザーが上書きした内容を無視し、指定した LCID のシステム既定値が返されます。
- lpLCData
- 要求したロケール情報を受け取るバッファへのポインタを指定します。
- cchData
- lpLCData パラメータが指すバッファのサイズを、バイト単位(ANSI 版)、または文字単位(Unicode 版)で指定します。0 を指定すると、情報を格納するのに必要なバイト数、または文字数が返ります。この場合、lpLCData パラメータが指すバッファは使われません。
戻り値
関数が成功すると、情報の格納先バッファに書き込まれたバイト数(ANSI 版)または文字数(Unicode 版)が返ります。cchData パラメータに 0 を指定した場合は、ロケールの情報を格納するのに必要なバイト数、または文字数が返ります。
関数が失敗すると、0 が返ります。拡張エラー情報を取得するには、GetLastError 関数を使います。GetLastError 関数は、次のいずれかのエラーコードを返します。
| ERROR_INSUFFICIENT_BUFFER |
| ERROR_INVALID_FLAGS |
| ERROR_INVALID_PARAMETER |
解説
GetLocaleInfo 関数は常にテキスト形式で情報を取得します。情報が数値の場合、10 進表記を使ってテキストに変換します。
対応情報
Windows NT/2000:Windows NT 3.1 以降
Windows 95/98:Windows 95 以降
ヘッダー:winnls.h 内で宣言
インポートライブラリ:kernel32.lib を使用
Unicode:Windows NT/2000 は Unicode 版と ANSI 版を実装
参照
、、、GetSystemDefaultLCID、GetUserDefaultLCID、SetLocaleInfo、