GetLocaleInfoA 関数 (winnls.h)
識別子で指定されたロケールに関する情報を取得します。
構文
int GetLocaleInfoA(
[in] LCID Locale,
[in] LCTYPE LCType,
[out, optional] LPSTR lpLCData,
[in] int cchData
);
パラメーター
[in] Locale
情報を取得するロケール識別子。 MAKELCID マクロを使用してロケール識別子を作成するか、次のいずれかの定義済み値を使用できます。
- LOCALE_CUSTOM_DEFAULT
- LOCALE_CUSTOM_UI_DEFAULT
- LOCALE_CUSTOM_UNSPECIFIED
- LOCALE_INVARIANT
- LOCALE_SYSTEM_DEFAULT
- LOCALE_USER_DEFAULT
[in] LCType
取得するロケール情報。 詳細な定義については、GetLocaleInfoEx の LCType パラメーターを参照してください。
[out, optional] lpLCData
この関数が要求されたロケール情報を取得するバッファーへのポインター。 cchData が 0 に設定されている場合、このポインターは使用されません。 詳細については、「解説」を参照してください。
[in] cchData
lpLCData で示されるデータ バッファーのサイズ (TCHAR 値)。 または、アプリケーションでこのパラメーターを 0 に設定することもできます。 この場合、関数は lpLCData パラメーターを使用せず、終端の null 文字を含め、必要なバッファー サイズを返します。
戻り値
成功した場合にロケール データ バッファーで取得された文字数を返し、 cchData が 0 以外の値です。 関数が成功し、 cchData が 0 以外で、 LOCALE_RETURN_NUMBER が指定されている場合、戻り値はデータ バッファーで取得された整数のサイズになります。つまり、関数の Unicode バージョンの場合は 2、ANSI バージョンの場合は 4 です。 関数が成功し、 cchData の値が 0 の場合、戻り値はロケール データ バッファーに必要なサイズ (null 文字を含む文字) になります。
成功しなかった場合、関数は 0 を返します。 拡張エラー情報を取得するために、アプリケーションは GetLastError を呼び出すことができます。これにより、次のいずれかのエラー コードが返されます。
- ERROR_INSUFFICIENT_BUFFER。 指定されたバッファー サイズが十分に大きくなかったか、 正しく NULL に設定されていませんでした。
- ERROR_INVALID_FLAGS。 フラグに指定された値が無効でした。
- ERROR_INVALID_PARAMETER。 パラメーター値のいずれかが無効です。
解説
この関数の操作については、「 GetLocaleInfoEx の備考」を参照してください。
int ret;
CALID calid;
DWORD value;
ret = GetLocaleInfo(LOCALE_USER_DEFAULT,
LOCALE_ICALENDARTYPE | LOCALE_RETURN_NUMBER,
(LPTSTR)&value,
sizeof(value) / sizeof(TCHAR) );
calid = value;
LOCALESIGNATURE LocSig;
ret = GetLocaleInfo(LOCALE_USER_DEFAULT,
LOCALE_FONTSIGNATURE,
(LPWSTR)&LocSig,
sizeof(LocSig) / sizeof(TCHAR) );
この関数の ANSI バージョンによって取得された ANSI 文字列は、ロケール識別子の既定の ANSI コード ページに基づいて Unicode から ANSI に変換されます。 ただし、 LOCALE_USE_CP_ACP が指定されている場合、変換はシステムの既定の ANSI コード ページに基づいています。
この関数の ANSI バージョンを Unicode のみのロケール識別子と共に使用すると、オペレーティング システムでシステム コード ページが使用されるため、関数は成功する可能性があります。 ただし、システム コード ページで未定義の文字は、文字列に疑問符 (?) として表示されます。
注意
winnls.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetLocaleInfo を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリ |UWP アプリ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリ |UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winnls.h (Windows.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |