ホーム › Globalization › GetSystemDefaultLocaleName

GetSystemDefaultLocaleName

関数

システム既定のロケール名を取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

INT GetSystemDefaultLocaleName(
    LPWSTR lpLocaleName,
    INT cchLocaleName
);

パラメーター

名前	型	方向	説明
lpLocaleName	LPWSTR	out	この関数がロケール名を取得して格納するバッファーへのポインター。
cchLocaleName	INT	in	lpLocaleName で指定される出力バッファーのサイズ（文字数）。ロケール名が取り得る最大文字長（終端の null 文字を含む）は LOCALE_NAME_MAX_LENGTH の値です。これが推奨されるサイズです。

戻り値の型: INT

公式ドキュメント

システム既定のロケール名を取得します。注意アプリケーションは、この関数よりも GetUserDefaultLocaleName を優先して呼び出すことが推奨されます。

戻り値

成功した場合、終端の null 文字を含むロケール名の長さを示す 0 より大きい値を返します。

この関数は、成功しなかった場合に 0 を返します。拡張エラー情報を取得するには、アプリケーションは GetLastError を呼び出すことができ、次のいずれかのエラーコードが返されることがあります。

ERROR_INSUFFICIENT_BUFFER。指定されたバッファーサイズが十分な大きさでなかったか、誤って NULL に設定されていました。

解説(Remarks)

この関数は、カスタムロケールからデータを取得できます。データがコンピューター間やアプリケーションの実行ごとに同一である保証はありません。アプリケーションでデータを永続化または送信する必要がある場合は、永続的なロケールデータの使用を参照してください。

Examples

この関数の使用例は、NLS: Name-based APIs Sample で確認できます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

INT GetSystemDefaultLocaleName(
    LPWSTR lpLocaleName,
    INT cchLocaleName
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetSystemDefaultLocaleName(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpLocaleName,   // LPWSTR out
    int cchLocaleName   // INT
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetSystemDefaultLocaleName(
    <MarshalAs(UnmanagedType.LPWStr)> lpLocaleName As System.Text.StringBuilder,   ' LPWSTR out
    cchLocaleName As Integer   ' INT
) As Integer
End Function

' lpLocaleName : LPWSTR out
' cchLocaleName : INT
Declare PtrSafe Function GetSystemDefaultLocaleName Lib "kernel32" ( _
    ByVal lpLocaleName As LongPtr, _
    ByVal cchLocaleName As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetSystemDefaultLocaleName = ctypes.windll.kernel32.GetSystemDefaultLocaleName
GetSystemDefaultLocaleName.restype = ctypes.c_int
GetSystemDefaultLocaleName.argtypes = [
    wintypes.LPWSTR,  # lpLocaleName : LPWSTR out
    ctypes.c_int,  # cchLocaleName : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetSystemDefaultLocaleName = Fiddle::Function.new(
  lib['GetSystemDefaultLocaleName'],
  [
    Fiddle::TYPE_VOIDP,  # lpLocaleName : LPWSTR out
    Fiddle::TYPE_INT,  # cchLocaleName : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetSystemDefaultLocaleName(
        lpLocaleName: *mut u16,  // LPWSTR out
        cchLocaleName: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern int GetSystemDefaultLocaleName([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpLocaleName, int cchLocaleName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetSystemDefaultLocaleName' -Namespace Win32 -PassThru
# $api::GetSystemDefaultLocaleName(lpLocaleName, cchLocaleName)

#uselib "KERNEL32.dll"
#func global GetSystemDefaultLocaleName "GetSystemDefaultLocaleName" sptr, sptr
; GetSystemDefaultLocaleName varptr(lpLocaleName), cchLocaleName   ; 戻り値は stat
; lpLocaleName : LPWSTR out -> "sptr"
; cchLocaleName : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetSystemDefaultLocaleName "GetSystemDefaultLocaleName" var, int
; res = GetSystemDefaultLocaleName(lpLocaleName, cchLocaleName)
; lpLocaleName : LPWSTR out -> "var"
; cchLocaleName : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetSystemDefaultLocaleName "GetSystemDefaultLocaleName" sptr, int
; res = GetSystemDefaultLocaleName(varptr(lpLocaleName), cchLocaleName)
; lpLocaleName : LPWSTR out -> "sptr"
; cchLocaleName : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。