VerifyScripts

関数

テスト文字列がロケール許可スクリプトのみで構成されるか検証する。

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

シグネチャ

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

BOOL VerifyScripts(
    DWORD dwFlags,
    LPCWSTR lpLocaleScripts,
    INT cchLocaleScripts,
    LPCWSTR lpTestScripts,
    INT cchTestScripts
);

パラメーター

名前

型

方向

説明

dwFlags

DWORD

スクリプトの検証オプションを指定するフラグです。

値	意味
VS_ALLOW_LATIN	テストリストに含まれる "Latn"(ラテン文字スクリプト)を、ロケールリストに含まれていない場合でも許可します。

lpLocaleScripts

LPCWSTR

ロケールリストへのポインターです。これは特定のロケールについて列挙されたスクリプトのリストです。このリストは通常、LCType に LOCALE_SSCRIPTS を指定して GetLocaleInfoEx を呼び出すことで取得します。

cchLocaleScripts

INT

lpLocaleScripts が指す文字列のサイズ(文字数)です。文字列が null 終端されている場合、アプリケーションはこのパラメーターに -1 を設定します。このパラメーターに 0 を設定すると、関数は失敗します。

lpTestScripts

LPCWSTR

テストリストへのポインターです。これは列挙されたスクリプトの 2 番目のリストです。このリストは通常、GetStringScripts を呼び出すことで取得します。

cchTestScripts

INT

lpTestScripts が指す文字列のサイズ(文字数)です。文字列が null 終端されている場合、アプリケーションはこのパラメーターに -1 を設定します。このパラメーターに 0 を設定すると、関数は失敗します。

戻り値の型: BOOL

公式ドキュメント

列挙された 2 つのスクリプトのリストを比較します。

戻り値

テストリストが空でなく、リスト内のすべての項目がロケールリストにも含まれている場合に TRUE を返します。ロケールリストがテストリストより多くのスクリプトを含んでいても関数は TRUE を返しますが、テストリストのすべてのスクリプトがロケールリストに含まれている必要があります。dwFlags に VS_ALLOW_LATIN が指定されている場合、関数は "Latn;" が常にロケールリストに含まれているかのように動作します。

それ以外のすべての場合、関数は FALSE を返します。この戻り値は、テストリストにロケールリストに含まれない項目があることを示す場合もあれば、エラーを示す場合もあります。この 2 つのケースを区別するには、アプリケーションは GetLastError を呼び出します。これは次のいずれかのエラーコードを返すことがあります。

ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。
ERROR_SUCCESS。処理は正常に完了しましたが、結果は得られませんでした。

解説(Remarks)

この関数は、"Latn;Cyrl;" のように、4 文字のスクリプト名を並べ、各スクリプト名の後にセミコロンを付けた文字列同士を比較します。また、ラテン文字スクリプトが本来の言語ではない言語やロケールでもしばしば使用されるという事実を考慮した特別な処理も行います。

この関数は、国際化ドメイン名(IDN)に関連するセキュリティ問題を緩和するための戦略の一部として役立ちます。

以下は、さまざまなシナリオにおけるこの関数の戻り値と、それに続く GetLastError の呼び出しの例です。最後の 2 つの例は、それぞれ、テストリストに終端のセミコロンがない場合(不正な形式の文字列)と、テストリストが空の場合を示しています。

ロケール文字列	テスト文字列	dwFlags	戻り値	GetLastError の戻り値
Hani;Hira;Kana;	Hani;	*	TRUE	(変化なし)
Hani;Hira;Kana;	Hani;Latn;	0	FALSE	ERROR_SUCCESS
Hani;Hira;Kana;	Hani;Latn;	VS_ALLOW_LATIN	TRUE	(変化なし)
Hani;Hira;Kana;	Cyrl;	*	FALSE	ERROR_SUCCESS
Hani;	Hani;Hira;Kana;	*	FALSE	ERROR_SUCCESS
Hani;Hira;Kana;	Cyrl	*	FALSE	ERROR_INVALID_PARAMETER
Hani;Hira;Kana;		*	TRUE	(変化なし)

dwFlags パラメーターに VS_ALLOW_LATIN を渡しても、フラグを指定しなくても、結果は同じです。

例

NLS: 国際化ドメイン名(IDN)緩和サンプルは、この関数の使用方法を示しています。

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

各言語での呼び出し定義

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

BOOL VerifyScripts(
    DWORD dwFlags,
    LPCWSTR lpLocaleScripts,
    INT cchLocaleScripts,
    LPCWSTR lpTestScripts,
    INT cchTestScripts
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool VerifyScripts(
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string lpLocaleScripts,   // LPCWSTR
    int cchLocaleScripts,   // INT
    [MarshalAs(UnmanagedType.LPWStr)] string lpTestScripts,   // LPCWSTR
    int cchTestScripts   // INT
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function VerifyScripts(
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpLocaleScripts As String,   ' LPCWSTR
    cchLocaleScripts As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPWStr)> lpTestScripts As String,   ' LPCWSTR
    cchTestScripts As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' dwFlags : DWORD
' lpLocaleScripts : LPCWSTR
' cchLocaleScripts : INT
' lpTestScripts : LPCWSTR
' cchTestScripts : INT
Declare PtrSafe Function VerifyScripts Lib "kernel32" ( _
    ByVal dwFlags As Long, _
    ByVal lpLocaleScripts As LongPtr, _
    ByVal cchLocaleScripts As Long, _
    ByVal lpTestScripts As LongPtr, _
    ByVal cchTestScripts As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

VerifyScripts = ctypes.windll.kernel32.VerifyScripts
VerifyScripts.restype = wintypes.BOOL
VerifyScripts.argtypes = [
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCWSTR,  # lpLocaleScripts : LPCWSTR
    ctypes.c_int,  # cchLocaleScripts : INT
    wintypes.LPCWSTR,  # lpTestScripts : LPCWSTR
    ctypes.c_int,  # cchTestScripts : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
VerifyScripts = Fiddle::Function.new(
  lib['VerifyScripts'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpLocaleScripts : LPCWSTR
    Fiddle::TYPE_INT,  # cchLocaleScripts : INT
    Fiddle::TYPE_VOIDP,  # lpTestScripts : LPCWSTR
    Fiddle::TYPE_INT,  # cchTestScripts : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn VerifyScripts(
        dwFlags: u32,  // DWORD
        lpLocaleScripts: *const u16,  // LPCWSTR
        cchLocaleScripts: i32,  // INT
        lpTestScripts: *const u16,  // LPCWSTR
        cchTestScripts: 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 VerifyScripts(uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] string lpLocaleScripts, int cchLocaleScripts, [MarshalAs(UnmanagedType.LPWStr)] string lpTestScripts, int cchTestScripts);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_VerifyScripts' -Namespace Win32 -PassThru
# $api::VerifyScripts(dwFlags, lpLocaleScripts, cchLocaleScripts, lpTestScripts, cchTestScripts)

#uselib "KERNEL32.dll"
#func global VerifyScripts "VerifyScripts" sptr, sptr, sptr, sptr, sptr
; VerifyScripts dwFlags, lpLocaleScripts, cchLocaleScripts, lpTestScripts, cchTestScripts   ; 戻り値は stat
; dwFlags : DWORD -> "sptr"
; lpLocaleScripts : LPCWSTR -> "sptr"
; cchLocaleScripts : INT -> "sptr"
; lpTestScripts : LPCWSTR -> "sptr"
; cchTestScripts : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "KERNEL32.dll"
#cfunc global VerifyScripts "VerifyScripts" int, wstr, int, wstr, int
; res = VerifyScripts(dwFlags, lpLocaleScripts, cchLocaleScripts, lpTestScripts, cchTestScripts)
; dwFlags : DWORD -> "int"
; lpLocaleScripts : LPCWSTR -> "wstr"
; cchLocaleScripts : INT -> "int"
; lpTestScripts : LPCWSTR -> "wstr"
; cchTestScripts : INT -> "int"

; BOOL VerifyScripts(DWORD dwFlags, LPCWSTR lpLocaleScripts, INT cchLocaleScripts, LPCWSTR lpTestScripts, INT cchTestScripts)
#uselib "KERNEL32.dll"
#cfunc global VerifyScripts "VerifyScripts" int, wstr, int, wstr, int
; res = VerifyScripts(dwFlags, lpLocaleScripts, cchLocaleScripts, lpTestScripts, cchTestScripts)
; dwFlags : DWORD -> "int"
; lpLocaleScripts : LPCWSTR -> "wstr"
; cchLocaleScripts : INT -> "int"
; lpTestScripts : LPCWSTR -> "wstr"
; cchTestScripts : INT -> "int"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procVerifyScripts = kernel32.NewProc("VerifyScripts")
)

// dwFlags (DWORD), lpLocaleScripts (LPCWSTR), cchLocaleScripts (INT), lpTestScripts (LPCWSTR), cchTestScripts (INT)
r1, _, err := procVerifyScripts.Call(
	uintptr(dwFlags),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpLocaleScripts))),
	uintptr(cchLocaleScripts),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpTestScripts))),
	uintptr(cchTestScripts),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function VerifyScripts(
  dwFlags: DWORD;   // DWORD
  lpLocaleScripts: PWideChar;   // LPCWSTR
  cchLocaleScripts: Integer;   // INT
  lpTestScripts: PWideChar;   // LPCWSTR
  cchTestScripts: Integer   // INT
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'VerifyScripts';

result := DllCall("KERNEL32\VerifyScripts"
    , "UInt", dwFlags   ; DWORD
    , "WStr", lpLocaleScripts   ; LPCWSTR
    , "Int", cchLocaleScripts   ; INT
    , "WStr", lpTestScripts   ; LPCWSTR
    , "Int", cchTestScripts   ; INT
    , "Int")   ; return: BOOL

●VerifyScripts(dwFlags, lpLocaleScripts, cchLocaleScripts, lpTestScripts, cchTestScripts) = DLL("KERNEL32.dll", "bool VerifyScripts(dword, char*, int, char*, int)")
# 呼び出し: VerifyScripts(dwFlags, lpLocaleScripts, cchLocaleScripts, lpTestScripts, cchTestScripts)
# dwFlags : DWORD -> "dword"
# lpLocaleScripts : LPCWSTR -> "char*"
# cchLocaleScripts : INT -> "int"
# lpTestScripts : LPCWSTR -> "char*"
# cchTestScripts : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "kernel32" fn VerifyScripts(
    dwFlags: u32, // DWORD
    lpLocaleScripts: [*c]const u16, // LPCWSTR
    cchLocaleScripts: i32, // INT
    lpTestScripts: [*c]const u16, // LPCWSTR
    cchTestScripts: i32 // INT
) callconv(std.os.windows.WINAPI) i32;

proc VerifyScripts(
    dwFlags: uint32,  # DWORD
    lpLocaleScripts: WideCString,  # LPCWSTR
    cchLocaleScripts: int32,  # INT
    lpTestScripts: WideCString,  # LPCWSTR
    cchTestScripts: int32  # INT
): int32 {.importc: "VerifyScripts", stdcall, dynlib: "KERNEL32.dll".}

pragma(lib, "kernel32");
extern(Windows)
int VerifyScripts(
    uint dwFlags,   // DWORD
    const(wchar)* lpLocaleScripts,   // LPCWSTR
    int cchLocaleScripts,   // INT
    const(wchar)* lpTestScripts,   // LPCWSTR
    int cchTestScripts   // INT
);

ccall((:VerifyScripts, "KERNEL32.dll"), stdcall, Int32,
      (UInt32, Cwstring, Int32, Cwstring, Int32),
      dwFlags, lpLocaleScripts, cchLocaleScripts, lpTestScripts, cchTestScripts)
# dwFlags : DWORD -> UInt32
# lpLocaleScripts : LPCWSTR -> Cwstring
# cchLocaleScripts : INT -> Int32
# lpTestScripts : LPCWSTR -> Cwstring
# cchTestScripts : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t VerifyScripts(
    uint32_t dwFlags,
    const uint16_t* lpLocaleScripts,
    int32_t cchLocaleScripts,
    const uint16_t* lpTestScripts,
    int32_t cchTestScripts);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.VerifyScripts(dwFlags, lpLocaleScripts, cchLocaleScripts, lpTestScripts, cchTestScripts)
-- dwFlags : DWORD
-- lpLocaleScripts : LPCWSTR
-- cchLocaleScripts : INT
-- lpTestScripts : LPCWSTR
-- cchTestScripts : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const VerifyScripts = lib.func('__stdcall', 'VerifyScripts', 'int32_t', ['uint32_t', 'str16', 'int32_t', 'str16', 'int32_t']);
// VerifyScripts(dwFlags, lpLocaleScripts, cchLocaleScripts, lpTestScripts, cchTestScripts)
// dwFlags : DWORD -> 'uint32_t'
// lpLocaleScripts : LPCWSTR -> 'str16'
// cchLocaleScripts : INT -> 'int32_t'
// lpTestScripts : LPCWSTR -> 'str16'
// cchTestScripts : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("KERNEL32.dll", {
  VerifyScripts: { parameters: ["u32", "buffer", "i32", "buffer", "i32"], result: "i32" },
});
// lib.symbols.VerifyScripts(dwFlags, lpLocaleScripts, cchLocaleScripts, lpTestScripts, cchTestScripts)
// dwFlags : DWORD -> "u32"
// lpLocaleScripts : LPCWSTR -> "buffer"
// cchLocaleScripts : INT -> "i32"
// lpTestScripts : LPCWSTR -> "buffer"
// cchTestScripts : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t VerifyScripts(
    uint32_t dwFlags,
    const uint16_t* lpLocaleScripts,
    int32_t cchLocaleScripts,
    const uint16_t* lpTestScripts,
    int32_t cchTestScripts);
C, "KERNEL32.dll");
// $ffi->VerifyScripts(dwFlags, lpLocaleScripts, cchLocaleScripts, lpTestScripts, cchTestScripts);
// dwFlags : DWORD
// lpLocaleScripts : LPCWSTR
// cchLocaleScripts : INT
// lpTestScripts : LPCWSTR
// cchTestScripts : INT
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。

import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean VerifyScripts(
        int dwFlags,   // DWORD
        WString lpLocaleScripts,   // LPCWSTR
        int cchLocaleScripts,   // INT
        WString lpTestScripts,   // LPCWSTR
        int cchTestScripts   // INT
    );
}

@[Link("kernel32")]
lib LibKERNEL32
  fun VerifyScripts = VerifyScripts(
    dwFlags : UInt32,   # DWORD
    lpLocaleScripts : UInt16*,   # LPCWSTR
    cchLocaleScripts : Int32,   # INT
    lpTestScripts : UInt16*,   # LPCWSTR
    cchTestScripts : Int32   # INT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef VerifyScriptsNative = Int32 Function(Uint32, Pointer<Utf16>, Int32, Pointer<Utf16>, Int32);
typedef VerifyScriptsDart = int Function(int, Pointer<Utf16>, int, Pointer<Utf16>, int);
final VerifyScripts = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<VerifyScriptsNative, VerifyScriptsDart>('VerifyScripts');
// dwFlags : DWORD -> Uint32
// lpLocaleScripts : LPCWSTR -> Pointer<Utf16>
// cchLocaleScripts : INT -> Int32
// lpTestScripts : LPCWSTR -> Pointer<Utf16>
// cchTestScripts : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function VerifyScripts(
  dwFlags: DWORD;   // DWORD
  lpLocaleScripts: PWideChar;   // LPCWSTR
  cchLocaleScripts: Integer;   // INT
  lpTestScripts: PWideChar;   // LPCWSTR
  cchTestScripts: Integer   // INT
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'VerifyScripts';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "VerifyScripts"
  c_VerifyScripts :: Word32 -> CWString -> Int32 -> CWString -> Int32 -> IO CInt
-- dwFlags : DWORD -> Word32
-- lpLocaleScripts : LPCWSTR -> CWString
-- cchLocaleScripts : INT -> Int32
-- lpTestScripts : LPCWSTR -> CWString
-- cchTestScripts : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let verifyscripts =
  foreign "VerifyScripts"
    (uint32_t @-> (ptr uint16_t) @-> int32_t @-> (ptr uint16_t) @-> int32_t @-> returning int32_t)
(* dwFlags : DWORD -> uint32_t *)
(* lpLocaleScripts : LPCWSTR -> (ptr uint16_t) *)
(* cchLocaleScripts : INT -> int32_t *)
(* lpTestScripts : LPCWSTR -> (ptr uint16_t) *)
(* cchTestScripts : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("VerifyScripts" verify-scripts :convention :stdcall) :int32
  (dw-flags :uint32)   ; DWORD
  (lp-locale-scripts (:string :encoding :utf-16le))   ; LPCWSTR
  (cch-locale-scripts :int32)   ; INT
  (lp-test-scripts (:string :encoding :utf-16le))   ; LPCWSTR
  (cch-test-scripts :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $VerifyScripts = Win32::API::More->new('KERNEL32',
    'BOOL VerifyScripts(DWORD dwFlags, LPCWSTR lpLocaleScripts, int cchLocaleScripts, LPCWSTR lpTestScripts, int cchTestScripts)');
# my $ret = $VerifyScripts->Call($dwFlags, $lpLocaleScripts, $cchLocaleScripts, $lpTestScripts, $cchTestScripts);
# dwFlags : DWORD -> DWORD
# lpLocaleScripts : LPCWSTR -> LPCWSTR
# cchLocaleScripts : INT -> int
# lpTestScripts : LPCWSTR -> LPCWSTR
# cchTestScripts : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。