GetNLSVersionEx

関数

指定ロケールのNLS機能のバージョン情報を取得する。

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

シグネチャ

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

BOOL GetNLSVersionEx(
    DWORD function,
    LPCWSTR lpLocaleName,   // optional
    NLSVERSIONINFOEX* lpVersionInformation
);

パラメーター

名前型方向説明

function DWORD in 照会する NLS 機能。この値は COMPARE_STRING でなければなりません。SYSNLS_FUNCTION 列挙体を参照してください。

lpLocaleName

名前	型	方向	説明
function	DWORD	in	照会する NLS 機能。この値は COMPARE_STRING でなければなりません。SYSNLS_FUNCTION 列挙体を参照してください。
lpLocaleName	LPCWSTR	inoptional	ロケール名へのポインター、または次の定義済みの値のいずれか。 LOCALE_NAME_INVARIANT LOCALE_NAME_SYSTEM_DEFAULT LOCALE_NAME_USER_DEFAULT
lpVersionInformation	NLSVERSIONINFOEX*	inout	NLSVERSIONINFOEX 構造体へのポインター。アプリケーションは dwNLSVersionInfoSize メンバーを `sizeof(NLSVERSIONINFOEX)` に初期化する必要があります。注意 Windows Vista 以降では、この関数はバージョン情報を NLSVERSIONINFO 構造体で提供することもできます。

LPCWSTR

inoptional

ロケール名へのポインター、または次の定義済みの値のいずれか。

lpVersionInformation

NLSVERSIONINFOEX*

inout

NLSVERSIONINFOEX 構造体へのポインター。アプリケーションは dwNLSVersionInfoSize メンバーを sizeof(NLSVERSIONINFOEX) に初期化する必要があります。

注意 Windows Vista 以降では、この関数はバージョン情報を NLSVERSIONINFO 構造体で提供することもできます。

戻り値の型: BOOL

公式ドキュメント

名前で指定したロケールについて、指定した NLS 機能の現在のバージョン情報を取得します。注意: Windows Vista 以降でのみ動作するように設計されたアプリケーションでは、GetNLSVersion よりもこの関数を優先して呼び出してください。

戻り値

アプリケーションが lpVersionInformation に有効な値を渡した場合にのみ TRUE を返し、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、GetLastError を呼び出します。次のいずれかのエラーコードが返されることがあります。

ERROR_INSUFFICIENT_BUFFER。指定されたバッファーサイズが十分に大きくないか、誤って NULL に設定されていました。
ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。

解説(Remarks)

この関数を使用すると、Active Directory のようなアプリケーションは、NLS の変更が特定のインデックステーブルで使用されるロケールに影響するかどうかを判断できます。影響しない場合、テーブルを再インデックスする必要はありません。詳細については、Handling Sorting in Your Applications を参照してください。特に、並べ替えバージョンが変更されたために再インデックスが必要かどうかを判断するには、次の手順を実行します。

データの最初のインデックス作成時に GetNLSVersionEx を使用して NLSVERSIONINFOEX 構造体を取得します。
バージョンを識別するために、次のプロパティをインデックスとともに保存します。
- NLSVERSIONINFOEX.dwNLSVersion。使用している並べ替えテーブルのバージョンを指定します。
- NLSVERSIONINFOEX.dwEffectiveId。並べ替えの有効なロケールを指定します。カスタムロケールは、組み込みロケールの並べ替えを指します。
- NLSVERSIONINFOEX.guidCustomVersion。これは、固有のカスタム並べ替えを持つカスタムロケール用に、その並べ替えを指定する GUID です。
インデックスを使用するときに GetNLSVersionEx を使用して、データのバージョンを確認します。
3 つのプロパティのいずれかが変更されている場合、使用している並べ替えデータが異なる結果を返す可能性があり、作成済みのインデックスではレコードを見つけられないことがあります。
データに無効な Unicode コードポイントが含まれていない(つまり、すべての文字列が IsNLSDefinedString の呼び出しを通過した)ことが確実であれば、dwNLSVersion の下位バイトのみ(上記で説明したマイナーバージョン)が変更された場合には、同一とみなしてもかまいません。

この内容は、ブログ記事 "How to tell if the collation version changed" (http://blogs.msdn.com/shawnste/archive/2007/06/01/how-to-tell-if-the-collation-version-changed.aspx) でより詳しく説明されています。

この関数はカスタムロケールをサポートします。lpLocaleName が補助ロケールを指定している場合、取得されるデータは、その補助ロケールに関連付けられた並べ替え順序に対応する正しいデータです。

Windows 8 以降: アプリが Windows.Globalization 名前空間の言語タグをこの関数に渡す場合、まず ResolveLocaleName を呼び出してタグを変換する必要があります。

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

各言語での呼び出し定義

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

BOOL GetNLSVersionEx(
    DWORD function,
    LPCWSTR lpLocaleName,   // optional
    NLSVERSIONINFOEX* lpVersionInformation
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetNLSVersionEx(
    uint function,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName,   // LPCWSTR optional
    IntPtr lpVersionInformation   // NLSVERSIONINFOEX* in/out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetNLSVersionEx(
    [function] As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpLocaleName As String,   ' LPCWSTR optional
    lpVersionInformation As IntPtr   ' NLSVERSIONINFOEX* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' function : DWORD
' lpLocaleName : LPCWSTR optional
' lpVersionInformation : NLSVERSIONINFOEX* in/out
Declare PtrSafe Function GetNLSVersionEx Lib "kernel32" ( _
    ByVal function As Long, _
    ByVal lpLocaleName As LongPtr, _
    ByVal lpVersionInformation As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetNLSVersionEx = ctypes.windll.kernel32.GetNLSVersionEx
GetNLSVersionEx.restype = wintypes.BOOL
GetNLSVersionEx.argtypes = [
    wintypes.DWORD,  # function : DWORD
    wintypes.LPCWSTR,  # lpLocaleName : LPCWSTR optional
    ctypes.c_void_p,  # lpVersionInformation : NLSVERSIONINFOEX* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetNLSVersionEx = Fiddle::Function.new(
  lib['GetNLSVersionEx'],
  [
    -Fiddle::TYPE_INT,  # function : DWORD
    Fiddle::TYPE_VOIDP,  # lpLocaleName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpVersionInformation : NLSVERSIONINFOEX* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetNLSVersionEx(
        function: u32,  // DWORD
        lpLocaleName: *const u16,  // LPCWSTR optional
        lpVersionInformation: *mut NLSVERSIONINFOEX  // NLSVERSIONINFOEX* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool GetNLSVersionEx(uint function, [MarshalAs(UnmanagedType.LPWStr)] string lpLocaleName, IntPtr lpVersionInformation);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetNLSVersionEx' -Namespace Win32 -PassThru
# $api::GetNLSVersionEx(function, lpLocaleName, lpVersionInformation)

#uselib "KERNEL32.dll"
#func global GetNLSVersionEx "GetNLSVersionEx" sptr, sptr, sptr
; GetNLSVersionEx function, lpLocaleName, varptr(lpVersionInformation)   ; 戻り値は stat
; function : DWORD -> "sptr"
; lpLocaleName : LPCWSTR optional -> "sptr"
; lpVersionInformation : NLSVERSIONINFOEX* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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