ホーム › Globalization › IsNLSDefinedString

IsNLSDefinedString

関数

文字列がNLSで定義された有効な文字のみか判定する。

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

シグネチャ

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

BOOL IsNLSDefinedString(
    DWORD Function,
    DWORD dwFlags,
    NLSVERSIONINFO* lpVersionInformation,
    LPCWSTR lpString,
    INT cchStr
);

パラメーター

名前	型	方向	説明
Function	DWORD	in	照会する NLS 機能。この値は COMPARE_STRING でなければなりません。SYSNLS_FUNCTION 列挙体を参照してください。
dwFlags	DWORD	in	関数を定義するフラグ。0 でなければなりません。
lpVersionInformation	NLSVERSIONINFO*	in	バージョン情報を含む NLSVERSIONINFO 構造体へのポインター。通常、この情報は GetNLSVersion を呼び出して取得します。関数に現在のバージョンを使用させる場合、アプリケーションはこのパラメーターに NULL を設定します。
lpString	LPCWSTR	in	検査対象の UTF-16 文字列へのポインター。
cchStr	INT	in	lpString で示される文字列内の UTF-16 文字数。このカウントには終端の null 文字を含めることができます。終端の null 文字は常に定義済みであるため、終端の null 文字を文字数に含めても検査の動作には影響しません。アプリケーションは、文字列が null 終端であることを示すために -1 を指定してください。この場合、関数自身が文字列の長さを計算します。

戻り値の型: BOOL

公式ドキュメント

文字列内の各文字が、指定された NLS 機能において定義済みの結果を持つかどうかを判定します。

戻り値

入力文字列が有効である場合にのみ、成功すると TRUE を返します。それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、アプリケーションは GetLastError を呼び出すことができ、次のいずれかのエラーコードが返される可能性があります。

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

解説(Remarks)

この関数は定義済みの文字列と未定義の文字列を区別するため、Active Directory のようなアプリケーションが未定義のコードポイントを含む文字列を拒否できるようになります。この関数を使用することで、アプリケーションがデータベースを再インデックスする必要性を最小限に抑えられます。詳細については、アプリケーションでの並べ替えの処理を参照してください。

たとえば、Function が COMPARE_STRING に設定されている場合、IsNLSDefinedString は未定義のコードポイント、未定義の Unicode 文字を表すサロゲートペア、または不正な形式のサロゲートペアを検査します。特定の文字列に対してこの関数が TRUE を返す場合、LCMAP_SORTKEY を設定した CompareString または LCMapString によって取得される結果は、対応する NLS バージョンが変更されない限り、同一であることが保証されます。

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

各言語での呼び出し定義

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

BOOL IsNLSDefinedString(
    DWORD Function,
    DWORD dwFlags,
    NLSVERSIONINFO* lpVersionInformation,
    LPCWSTR lpString,
    INT cchStr
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool IsNLSDefinedString(
    uint Function,   // DWORD
    uint dwFlags,   // DWORD
    IntPtr lpVersionInformation,   // NLSVERSIONINFO*
    [MarshalAs(UnmanagedType.LPWStr)] string lpString,   // LPCWSTR
    int cchStr   // INT
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function IsNLSDefinedString(
    [Function] As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    lpVersionInformation As IntPtr,   ' NLSVERSIONINFO*
    <MarshalAs(UnmanagedType.LPWStr)> lpString As String,   ' LPCWSTR
    cchStr As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Function : DWORD
' dwFlags : DWORD
' lpVersionInformation : NLSVERSIONINFO*
' lpString : LPCWSTR
' cchStr : INT
Declare PtrSafe Function IsNLSDefinedString Lib "kernel32" ( _
    ByVal Function As Long, _
    ByVal dwFlags As Long, _
    ByVal lpVersionInformation As LongPtr, _
    ByVal lpString As LongPtr, _
    ByVal cchStr As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

IsNLSDefinedString = ctypes.windll.kernel32.IsNLSDefinedString
IsNLSDefinedString.restype = wintypes.BOOL
IsNLSDefinedString.argtypes = [
    wintypes.DWORD,  # Function : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # lpVersionInformation : NLSVERSIONINFO*
    wintypes.LPCWSTR,  # lpString : LPCWSTR
    ctypes.c_int,  # cchStr : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
IsNLSDefinedString = Fiddle::Function.new(
  lib['IsNLSDefinedString'],
  [
    -Fiddle::TYPE_INT,  # Function : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpVersionInformation : NLSVERSIONINFO*
    Fiddle::TYPE_VOIDP,  # lpString : LPCWSTR
    Fiddle::TYPE_INT,  # cchStr : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn IsNLSDefinedString(
        Function: u32,  // DWORD
        dwFlags: u32,  // DWORD
        lpVersionInformation: *mut NLSVERSIONINFO,  // NLSVERSIONINFO*
        lpString: *const u16,  // LPCWSTR
        cchStr: i32  // INT
    ) -> 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 IsNLSDefinedString(uint Function, uint dwFlags, IntPtr lpVersionInformation, [MarshalAs(UnmanagedType.LPWStr)] string lpString, int cchStr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_IsNLSDefinedString' -Namespace Win32 -PassThru
# $api::IsNLSDefinedString(Function, dwFlags, lpVersionInformation, lpString, cchStr)

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

出力引数:

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