GetSystemDefaultLocaleName 関数 (winnls.h)
システムの既定の ロケール名を取得します。
メモ アプリケーションでは、この関数よりも優先して GetUserDefaultLocaleName を 呼び出することをお勧めします。 これは、通常、ユーザーロケールがシステムロケールよりもユーザーにとって有用で正確であることが原因です。
メモ アプリケーションは、Windows Vista 以降でのみ実行するように設計されている場合は 、GetSystemDefaultLCID を優先してこの関数を呼び出す必要があります。
構文
int GetSystemDefaultLocaleName(
[out] LPWSTR lpLocaleName,
[in] int cchLocaleName
);
パラメーター
[out] lpLocaleName
この関数がロケール名を取得するバッファーへのポインター。
[in] cchLocaleName
lpLocaleName で示される出力バッファーのサイズ (文字単位)。 ロケール名の文字の最大文字数 (終端の null 文字を含む) は 、LOCALE_NAME_MAX_LENGTHの値です。 これは推奨されるサイズです。
戻り値
成功した場合は、ロケール名の長さを示す 0 より大きい値を返します (終了する null 文字を含む)。
成功しなかった場合、この関数は 0 を返します。 拡張エラー情報を取得するために、アプリケーションは GetLastError を呼び出すことができます。これにより、次のいずれかのエラー コードが返されます。
- ERROR_INSUFFICIENT_BUFFER。 指定されたバッファー サイズが十分に大きくなかったか、 正しく NULL に設定されていませんでした。
注釈
この関数は、 カスタム ロケールからデータを取得できます。 データは、コンピューター間、またはアプリケーションの実行間で同じになることは保証されません。 アプリケーションでデータを永続化または送信する必要がある場合は、「 永続的なロケール データの使用」を参照してください。
例
この関数の使用方法を示す例については、「 NLS: 名前ベースの API サンプル」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ | UWP アプリ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリ | UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winnls.h (Windows.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |