GetNLSVersion

関数

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

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

シグネチャ

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

BOOL GetNLSVersion(
    DWORD Function,
    DWORD Locale,
    NLSVERSIONINFO* lpVersionInformation
);

パラメーター

名前型方向説明

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

Locale

名前	型	方向	説明
Function	DWORD	in	問い合わせる NLS 機能。この値は COMPARE_STRING でなければなりません。SYSNLS_FUNCTION 列挙体を参照してください。
Locale	DWORD	in	ロケールを指定するロケール識別子。MAKELCID マクロを使用して識別子を作成するか、次の定義済みの値のいずれかを使用できます。 LOCALE_INVARIANT LOCALE_SYSTEM_DEFAULT LOCALE_USER_DEFAULT Windows Vista 以降: 次のカスタムロケール識別子もサポートされます。 LOCALE_CUSTOM_DEFAULT LOCALE_CUSTOM_UI_DEFAULT LOCALE_CUSTOM_UNSPECIFIED
lpVersionInformation	NLSVERSIONINFO*	inout	NLSVERSIONINFO 構造体へのポインター。アプリケーションは dwNLSVersionInfoSize メンバーを `sizeof(NLSVERSIONINFO)` に初期化する必要があります。注意 Windows Vista 以降では、この関数はバージョン情報を NLSVERSIONINFOEX 構造体で提供することもできます。

DWORD

ロケールを指定するロケール識別子。MAKELCID マクロを使用して識別子を作成するか、次の定義済みの値のいずれかを使用できます。

Windows Vista 以降: 次のカスタムロケール識別子もサポートされます。

lpVersionInformation

NLSVERSIONINFO*

inout

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

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

戻り値の型: BOOL

公式ドキュメント

識別子で指定したロケールについて、指定した NLS 機能の現在のバージョンに関する情報を取得します。注意相互運用性の理由から、アプリケーションは GetNLSVersion よりも GetNLSVersionEx 関数を使用することをお勧めします。これは、Microsoft が新しいロケールについてロケール識別子ではなくロケール名の使用へ移行を進めているためです。この推奨は特にカスタムロケールに当てはまり、カスタムロケールでは GetNLSVersionEx が並べ替え動作の変更を判断するのに十分な情報を取得します。Windows Vista 以降でのみ動作するアプリケーションは、GetNLSVersionEx を使用するか、少なくとも GetNLSVersion の呼び出し時に NLSVERSIONINFOEX 構造体を渡して、追加の並べ替えバージョン情報を取得してください。

戻り値

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

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

解説(Remarks)

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

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

各言語での呼び出し定義

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

BOOL GetNLSVersion(
    DWORD Function,
    DWORD Locale,
    NLSVERSIONINFO* lpVersionInformation
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetNLSVersion(
    uint Function,   // DWORD
    uint Locale,   // DWORD
    IntPtr lpVersionInformation   // NLSVERSIONINFO* in/out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetNLSVersion(
    [Function] As UInteger,   ' DWORD
    Locale As UInteger,   ' DWORD
    lpVersionInformation As IntPtr   ' NLSVERSIONINFO* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

GetNLSVersion = ctypes.windll.kernel32.GetNLSVersion
GetNLSVersion.restype = wintypes.BOOL
GetNLSVersion.argtypes = [
    wintypes.DWORD,  # Function : DWORD
    wintypes.DWORD,  # Locale : DWORD
    ctypes.c_void_p,  # lpVersionInformation : NLSVERSIONINFO* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetNLSVersion = Fiddle::Function.new(
  lib['GetNLSVersion'],
  [
    -Fiddle::TYPE_INT,  # Function : DWORD
    -Fiddle::TYPE_INT,  # Locale : DWORD
    Fiddle::TYPE_VOIDP,  # lpVersionInformation : NLSVERSIONINFO* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetNLSVersion(
        Function: u32,  // DWORD
        Locale: u32,  // DWORD
        lpVersionInformation: *mut NLSVERSIONINFO  // NLSVERSIONINFO* 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 GetNLSVersion(uint Function, uint Locale, IntPtr lpVersionInformation);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetNLSVersion' -Namespace Win32 -PassThru
# $api::GetNLSVersion(Function, Locale, lpVersionInformation)

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

出力引数:

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