CompareStringW
関数シグネチャ
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
COMPARESTRING_RESULT CompareStringW(
DWORD Locale,
DWORD dwCmpFlags,
LPCWSTR lpString1,
INT cchCount1,
LPCWSTR lpString2,
INT cchCount2
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| Locale | DWORD | in | 比較に使用するロケールの ロケール識別子。MAKELCID マクロを使用してロケール識別子を作成するか、次の定義済みの値のいずれかを使用できます。 |
| dwCmpFlags | DWORD | in | 関数が 2 つの文字列を比較する方法を示すフラグです。詳細な定義については、CompareStringEx の dwCmpFlags パラメーターを参照してください。 |
| lpString1 | LPCWSTR | in | 比較する 1 つ目の文字列へのポインターです。 |
| cchCount1 | INT | in | lpString1 で示される文字列の長さ。終端の null 文字は含みません。この値は、関数の ANSI 版ではバイト数を、Unicode 版ではワイド文字数を表します。文字列が null で終端されている場合、アプリケーションは負の値を指定できます。この場合、関数は長さを自動的に判別します。 |
| lpString2 | LPCWSTR | in | 比較する 2 つ目の文字列へのポインターです。 |
| cchCount2 | INT | in | lpString2 で示される文字列の長さ。終端の null 文字は含みません。この値は、関数の ANSI 版ではバイト数を、Unicode 版ではワイド文字数を表します。文字列が null で終端されている場合、アプリケーションは負の値を指定できます。この場合、関数は長さを自動的に判別します。 |
戻り値の型: COMPARESTRING_RESULT
公式ドキュメント
CompareStringW (Unicode) 関数 (stringapiset.h) は、識別子で指定したロケールに従って 2 つの文字列を比較します。
戻り値
CompareStringEx について説明されている値を返します。
解説(Remarks)
「解説」については CompareStringEx を参照してください。
アプリケーションが CompareString の ANSI 版を呼び出す場合、関数は指定されたロケールの既定のコードページを介してパラメーターを変換します。そのため、アプリケーションは CompareString を使用して UTF-8 テキストを扱うことはできません。
通常、大文字と小文字を区別しない比較では、ロケールがトルコ語またはアゼルバイジャン語であっても、CompareString は小文字の "i" を大文字の "I" にマップします。NORM_LINGUISTIC_CASING フラグはトルコ語またはアゼルバイジャン語に対してこの動作を上書きします。このフラグがトルコ語またはアゼルバイジャン語と組み合わせて指定された場合、LATIN SMALL LETTER DOTLESS I (U+0131) は LATIN CAPITAL LETTER I (U+0049) の小文字形であり、LATIN SMALL LETTER I (U+0069) は LATIN CAPITAL LETTER I WITH DOT ABOVE (U+0130) の小文字形となります。
Windows 8 以降: 関数の ANSI 版は Winnls.h で宣言され、Unicode 版は Stringapiset.h で宣言されています。Windows 8 より前は、両方の版が Winnls.h で宣言されていました。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
COMPARESTRING_RESULT CompareStringW(
DWORD Locale,
DWORD dwCmpFlags,
LPCWSTR lpString1,
INT cchCount1,
LPCWSTR lpString2,
INT cchCount2
);[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int CompareStringW(
uint Locale, // DWORD
uint dwCmpFlags, // DWORD
[MarshalAs(UnmanagedType.LPWStr)] string lpString1, // LPCWSTR
int cchCount1, // INT
[MarshalAs(UnmanagedType.LPWStr)] string lpString2, // LPCWSTR
int cchCount2 // INT
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function CompareStringW(
Locale As UInteger, ' DWORD
dwCmpFlags As UInteger, ' DWORD
<MarshalAs(UnmanagedType.LPWStr)> lpString1 As String, ' LPCWSTR
cchCount1 As Integer, ' INT
<MarshalAs(UnmanagedType.LPWStr)> lpString2 As String, ' LPCWSTR
cchCount2 As Integer ' INT
) As Integer
End Function' Locale : DWORD
' dwCmpFlags : DWORD
' lpString1 : LPCWSTR
' cchCount1 : INT
' lpString2 : LPCWSTR
' cchCount2 : INT
Declare PtrSafe Function CompareStringW Lib "kernel32" ( _
ByVal Locale As Long, _
ByVal dwCmpFlags As Long, _
ByVal lpString1 As LongPtr, _
ByVal cchCount1 As Long, _
ByVal lpString2 As LongPtr, _
ByVal cchCount2 As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
CompareStringW = ctypes.windll.kernel32.CompareStringW
CompareStringW.restype = ctypes.c_int
CompareStringW.argtypes = [
wintypes.DWORD, # Locale : DWORD
wintypes.DWORD, # dwCmpFlags : DWORD
wintypes.LPCWSTR, # lpString1 : LPCWSTR
ctypes.c_int, # cchCount1 : INT
wintypes.LPCWSTR, # lpString2 : LPCWSTR
ctypes.c_int, # cchCount2 : INT
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
CompareStringW = Fiddle::Function.new(
lib['CompareStringW'],
[
-Fiddle::TYPE_INT, # Locale : DWORD
-Fiddle::TYPE_INT, # dwCmpFlags : DWORD
Fiddle::TYPE_VOIDP, # lpString1 : LPCWSTR
Fiddle::TYPE_INT, # cchCount1 : INT
Fiddle::TYPE_VOIDP, # lpString2 : LPCWSTR
Fiddle::TYPE_INT, # cchCount2 : INT
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "kernel32")]
extern "system" {
fn CompareStringW(
Locale: u32, // DWORD
dwCmpFlags: u32, // DWORD
lpString1: *const u16, // LPCWSTR
cchCount1: i32, // INT
lpString2: *const u16, // LPCWSTR
cchCount2: i32 // INT
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode)]
public static extern int CompareStringW(uint Locale, uint dwCmpFlags, [MarshalAs(UnmanagedType.LPWStr)] string lpString1, int cchCount1, [MarshalAs(UnmanagedType.LPWStr)] string lpString2, int cchCount2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CompareStringW' -Namespace Win32 -PassThru
# $api::CompareStringW(Locale, dwCmpFlags, lpString1, cchCount1, lpString2, cchCount2)#uselib "KERNEL32.dll"
#func global CompareStringW "CompareStringW" wptr, wptr, wptr, wptr, wptr, wptr
; CompareStringW Locale, dwCmpFlags, lpString1, cchCount1, lpString2, cchCount2 ; 戻り値は stat
; Locale : DWORD -> "wptr"
; dwCmpFlags : DWORD -> "wptr"
; lpString1 : LPCWSTR -> "wptr"
; cchCount1 : INT -> "wptr"
; lpString2 : LPCWSTR -> "wptr"
; cchCount2 : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global CompareStringW "CompareStringW" int, int, wstr, int, wstr, int
; res = CompareStringW(Locale, dwCmpFlags, lpString1, cchCount1, lpString2, cchCount2)
; Locale : DWORD -> "int"
; dwCmpFlags : DWORD -> "int"
; lpString1 : LPCWSTR -> "wstr"
; cchCount1 : INT -> "int"
; lpString2 : LPCWSTR -> "wstr"
; cchCount2 : INT -> "int"; COMPARESTRING_RESULT CompareStringW(DWORD Locale, DWORD dwCmpFlags, LPCWSTR lpString1, INT cchCount1, LPCWSTR lpString2, INT cchCount2)
#uselib "KERNEL32.dll"
#cfunc global CompareStringW "CompareStringW" int, int, wstr, int, wstr, int
; res = CompareStringW(Locale, dwCmpFlags, lpString1, cchCount1, lpString2, cchCount2)
; Locale : DWORD -> "int"
; dwCmpFlags : DWORD -> "int"
; lpString1 : LPCWSTR -> "wstr"
; cchCount1 : INT -> "int"
; lpString2 : LPCWSTR -> "wstr"
; cchCount2 : INT -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procCompareStringW = kernel32.NewProc("CompareStringW")
)
// Locale (DWORD), dwCmpFlags (DWORD), lpString1 (LPCWSTR), cchCount1 (INT), lpString2 (LPCWSTR), cchCount2 (INT)
r1, _, err := procCompareStringW.Call(
uintptr(Locale),
uintptr(dwCmpFlags),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpString1))),
uintptr(cchCount1),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpString2))),
uintptr(cchCount2),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // COMPARESTRING_RESULTfunction CompareStringW(
Locale: DWORD; // DWORD
dwCmpFlags: DWORD; // DWORD
lpString1: PWideChar; // LPCWSTR
cchCount1: Integer; // INT
lpString2: PWideChar; // LPCWSTR
cchCount2: Integer // INT
): Integer; stdcall;
external 'KERNEL32.dll' name 'CompareStringW';result := DllCall("KERNEL32\CompareStringW"
, "UInt", Locale ; DWORD
, "UInt", dwCmpFlags ; DWORD
, "WStr", lpString1 ; LPCWSTR
, "Int", cchCount1 ; INT
, "WStr", lpString2 ; LPCWSTR
, "Int", cchCount2 ; INT
, "Int") ; return: COMPARESTRING_RESULT●CompareStringW(Locale, dwCmpFlags, lpString1, cchCount1, lpString2, cchCount2) = DLL("KERNEL32.dll", "int CompareStringW(dword, dword, char*, int, char*, int)")
# 呼び出し: CompareStringW(Locale, dwCmpFlags, lpString1, cchCount1, lpString2, cchCount2)
# Locale : DWORD -> "dword"
# dwCmpFlags : DWORD -> "dword"
# lpString1 : LPCWSTR -> "char*"
# cchCount1 : INT -> "int"
# lpString2 : LPCWSTR -> "char*"
# cchCount2 : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "kernel32" fn CompareStringW(
Locale: u32, // DWORD
dwCmpFlags: u32, // DWORD
lpString1: [*c]const u16, // LPCWSTR
cchCount1: i32, // INT
lpString2: [*c]const u16, // LPCWSTR
cchCount2: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc CompareStringW(
Locale: uint32, # DWORD
dwCmpFlags: uint32, # DWORD
lpString1: WideCString, # LPCWSTR
cchCount1: int32, # INT
lpString2: WideCString, # LPCWSTR
cchCount2: int32 # INT
): int32 {.importc: "CompareStringW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "kernel32");
extern(Windows)
int CompareStringW(
uint Locale, // DWORD
uint dwCmpFlags, // DWORD
const(wchar)* lpString1, // LPCWSTR
int cchCount1, // INT
const(wchar)* lpString2, // LPCWSTR
int cchCount2 // INT
);ccall((:CompareStringW, "KERNEL32.dll"), stdcall, Int32,
(UInt32, UInt32, Cwstring, Int32, Cwstring, Int32),
Locale, dwCmpFlags, lpString1, cchCount1, lpString2, cchCount2)
# Locale : DWORD -> UInt32
# dwCmpFlags : DWORD -> UInt32
# lpString1 : LPCWSTR -> Cwstring
# cchCount1 : INT -> Int32
# lpString2 : LPCWSTR -> Cwstring
# cchCount2 : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t CompareStringW(
uint32_t Locale,
uint32_t dwCmpFlags,
const uint16_t* lpString1,
int32_t cchCount1,
const uint16_t* lpString2,
int32_t cchCount2);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CompareStringW(Locale, dwCmpFlags, lpString1, cchCount1, lpString2, cchCount2)
-- Locale : DWORD
-- dwCmpFlags : DWORD
-- lpString1 : LPCWSTR
-- cchCount1 : INT
-- lpString2 : LPCWSTR
-- cchCount2 : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CompareStringW = lib.func('__stdcall', 'CompareStringW', 'int32_t', ['uint32_t', 'uint32_t', 'str16', 'int32_t', 'str16', 'int32_t']);
// CompareStringW(Locale, dwCmpFlags, lpString1, cchCount1, lpString2, cchCount2)
// Locale : DWORD -> 'uint32_t'
// dwCmpFlags : DWORD -> 'uint32_t'
// lpString1 : LPCWSTR -> 'str16'
// cchCount1 : INT -> 'int32_t'
// lpString2 : LPCWSTR -> 'str16'
// cchCount2 : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
CompareStringW: { parameters: ["u32", "u32", "buffer", "i32", "buffer", "i32"], result: "i32" },
});
// lib.symbols.CompareStringW(Locale, dwCmpFlags, lpString1, cchCount1, lpString2, cchCount2)
// Locale : DWORD -> "u32"
// dwCmpFlags : DWORD -> "u32"
// lpString1 : LPCWSTR -> "buffer"
// cchCount1 : INT -> "i32"
// lpString2 : LPCWSTR -> "buffer"
// cchCount2 : INT -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t CompareStringW(
uint32_t Locale,
uint32_t dwCmpFlags,
const uint16_t* lpString1,
int32_t cchCount1,
const uint16_t* lpString2,
int32_t cchCount2);
C, "KERNEL32.dll");
// $ffi->CompareStringW(Locale, dwCmpFlags, lpString1, cchCount1, lpString2, cchCount2);
// Locale : DWORD
// dwCmpFlags : DWORD
// lpString1 : LPCWSTR
// cchCount1 : INT
// lpString2 : LPCWSTR
// cchCount2 : 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, W32APIOptions.UNICODE_OPTIONS);
int CompareStringW(
int Locale, // DWORD
int dwCmpFlags, // DWORD
WString lpString1, // LPCWSTR
int cchCount1, // INT
WString lpString2, // LPCWSTR
int cchCount2 // INT
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("kernel32")]
lib LibKERNEL32
fun CompareStringW = CompareStringW(
Locale : UInt32, # DWORD
dwCmpFlags : UInt32, # DWORD
lpString1 : UInt16*, # LPCWSTR
cchCount1 : Int32, # INT
lpString2 : UInt16*, # LPCWSTR
cchCount2 : 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 CompareStringWNative = Int32 Function(Uint32, Uint32, Pointer<Utf16>, Int32, Pointer<Utf16>, Int32);
typedef CompareStringWDart = int Function(int, int, Pointer<Utf16>, int, Pointer<Utf16>, int);
final CompareStringW = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<CompareStringWNative, CompareStringWDart>('CompareStringW');
// Locale : DWORD -> Uint32
// dwCmpFlags : DWORD -> Uint32
// lpString1 : LPCWSTR -> Pointer<Utf16>
// cchCount1 : INT -> Int32
// lpString2 : LPCWSTR -> Pointer<Utf16>
// cchCount2 : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CompareStringW(
Locale: DWORD; // DWORD
dwCmpFlags: DWORD; // DWORD
lpString1: PWideChar; // LPCWSTR
cchCount1: Integer; // INT
lpString2: PWideChar; // LPCWSTR
cchCount2: Integer // INT
): Integer; stdcall;
external 'KERNEL32.dll' name 'CompareStringW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CompareStringW"
c_CompareStringW :: Word32 -> Word32 -> CWString -> Int32 -> CWString -> Int32 -> IO Int32
-- Locale : DWORD -> Word32
-- dwCmpFlags : DWORD -> Word32
-- lpString1 : LPCWSTR -> CWString
-- cchCount1 : INT -> Int32
-- lpString2 : LPCWSTR -> CWString
-- cchCount2 : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let comparestringw =
foreign "CompareStringW"
(uint32_t @-> uint32_t @-> (ptr uint16_t) @-> int32_t @-> (ptr uint16_t) @-> int32_t @-> returning int32_t)
(* Locale : DWORD -> uint32_t *)
(* dwCmpFlags : DWORD -> uint32_t *)
(* lpString1 : LPCWSTR -> (ptr uint16_t) *)
(* cchCount1 : INT -> int32_t *)
(* lpString2 : LPCWSTR -> (ptr uint16_t) *)
(* cchCount2 : 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 ("CompareStringW" compare-string-w :convention :stdcall) :int32
(locale :uint32) ; DWORD
(dw-cmp-flags :uint32) ; DWORD
(lp-string1 (:string :encoding :utf-16le)) ; LPCWSTR
(cch-count1 :int32) ; INT
(lp-string2 (:string :encoding :utf-16le)) ; LPCWSTR
(cch-count2 :int32)) ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $CompareStringW = Win32::API::More->new('KERNEL32',
'int CompareStringW(DWORD Locale, DWORD dwCmpFlags, LPCWSTR lpString1, int cchCount1, LPCWSTR lpString2, int cchCount2)');
# my $ret = $CompareStringW->Call($Locale, $dwCmpFlags, $lpString1, $cchCount1, $lpString2, $cchCount2);
# Locale : DWORD -> DWORD
# dwCmpFlags : DWORD -> DWORD
# lpString1 : LPCWSTR -> LPCWSTR
# cchCount1 : INT -> int
# lpString2 : LPCWSTR -> LPCWSTR
# cchCount2 : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f CompareStringA (ANSI版) — ロケールに従い二つのANSI文字列を比較する。
- f CompareStringEx — ロケール名を指定して二つの文字列を比較する。