Win32 API 日本語リファレンス
ホームUI.Shell › ChrCmpIW

ChrCmpIW

関数
大小文字を区別せず二つの文字を比較する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

BOOL ChrCmpIW(
    WCHAR w1,
    WCHAR w2
);

パラメーター

名前方向説明
w1WCHARin比較対象の 1 つ目の文字。
w2WCHARin比較対象の 2 つ目の文字。

戻り値の型: BOOL

公式ドキュメント

2 つの文字を比較します。この比較では大文字と小文字は区別されません。(Unicode)

戻り値

型: BOOL

2 つの文字が同じ場合は 0 を、それ以外の場合は 0 以外の値を返します。

解説(Remarks)

メモ

shlwapi.h ヘッダーは ChrCmpI をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

BOOL ChrCmpIW(
    WCHAR w1,
    WCHAR w2
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool ChrCmpIW(
    char w1,   // WCHAR
    char w2   // WCHAR
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ChrCmpIW(
    w1 As Char,   ' WCHAR
    w2 As Char   ' WCHAR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' w1 : WCHAR
' w2 : WCHAR
Declare PtrSafe Function ChrCmpIW Lib "shlwapi" ( _
    ByVal w1 As Integer, _
    ByVal w2 As Integer) 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

ChrCmpIW = ctypes.windll.shlwapi.ChrCmpIW
ChrCmpIW.restype = wintypes.BOOL
ChrCmpIW.argtypes = [
    ctypes.c_wchar,  # w1 : WCHAR
    ctypes.c_wchar,  # w2 : WCHAR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
ChrCmpIW = Fiddle::Function.new(
  lib['ChrCmpIW'],
  [
    Fiddle::TYPE_SHORT,  # w1 : WCHAR
    Fiddle::TYPE_SHORT,  # w2 : WCHAR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn ChrCmpIW(
        w1: u16,  // WCHAR
        w2: u16  // WCHAR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern bool ChrCmpIW(char w1, char w2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_ChrCmpIW' -Namespace Win32 -PassThru
# $api::ChrCmpIW(w1, w2)
#uselib "SHLWAPI.dll"
#func global ChrCmpIW "ChrCmpIW" wptr, wptr
; ChrCmpIW w1, w2   ; 戻り値は stat
; w1 : WCHAR -> "wptr"
; w2 : WCHAR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global ChrCmpIW "ChrCmpIW" int, int
; res = ChrCmpIW(w1, w2)
; w1 : WCHAR -> "int"
; w2 : WCHAR -> "int"
; BOOL ChrCmpIW(WCHAR w1, WCHAR w2)
#uselib "SHLWAPI.dll"
#cfunc global ChrCmpIW "ChrCmpIW" int, int
; res = ChrCmpIW(w1, w2)
; w1 : WCHAR -> "int"
; w2 : WCHAR -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procChrCmpIW = shlwapi.NewProc("ChrCmpIW")
)

// w1 (WCHAR), w2 (WCHAR)
r1, _, err := procChrCmpIW.Call(
	uintptr(w1),
	uintptr(w2),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ChrCmpIW(
  w1: WideChar;   // WCHAR
  w2: WideChar   // WCHAR
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'ChrCmpIW';
result := DllCall("SHLWAPI\ChrCmpIW"
    , "Short", w1   ; WCHAR
    , "Short", w2   ; WCHAR
    , "Int")   ; return: BOOL
●ChrCmpIW(w1, w2) = DLL("SHLWAPI.dll", "bool ChrCmpIW(int, int)")
# 呼び出し: ChrCmpIW(w1, w2)
# w1 : WCHAR -> "int"
# w2 : WCHAR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shlwapi" fn ChrCmpIW(
    w1: u16, // WCHAR
    w2: u16 // WCHAR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc ChrCmpIW(
    w1: uint16,  # WCHAR
    w2: uint16  # WCHAR
): int32 {.importc: "ChrCmpIW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
int ChrCmpIW(
    wchar w1,   // WCHAR
    wchar w2   // WCHAR
);
ccall((:ChrCmpIW, "SHLWAPI.dll"), stdcall, Int32,
      (UInt16, UInt16),
      w1, w2)
# w1 : WCHAR -> UInt16
# w2 : WCHAR -> UInt16
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t ChrCmpIW(
    uint16_t w1,
    uint16_t w2);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.ChrCmpIW(w1, w2)
-- w1 : WCHAR
-- w2 : WCHAR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const ChrCmpIW = lib.func('__stdcall', 'ChrCmpIW', 'int32_t', ['uint16_t', 'uint16_t']);
// ChrCmpIW(w1, w2)
// w1 : WCHAR -> 'uint16_t'
// w2 : WCHAR -> 'uint16_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  ChrCmpIW: { parameters: ["u16", "u16"], result: "i32" },
});
// lib.symbols.ChrCmpIW(w1, w2)
// w1 : WCHAR -> "u16"
// w2 : WCHAR -> "u16"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ChrCmpIW(
    uint16_t w1,
    uint16_t w2);
C, "SHLWAPI.dll");
// $ffi->ChrCmpIW(w1, w2);
// w1 : WCHAR
// w2 : WCHAR
// 構造体/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 Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.UNICODE_OPTIONS);
    boolean ChrCmpIW(
        char w1,   // WCHAR
        char w2   // WCHAR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun ChrCmpIW = ChrCmpIW(
    w1 : UInt16,   # WCHAR
    w2 : UInt16   # WCHAR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ChrCmpIWNative = Int32 Function(Uint16, Uint16);
typedef ChrCmpIWDart = int Function(int, int);
final ChrCmpIW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<ChrCmpIWNative, ChrCmpIWDart>('ChrCmpIW');
// w1 : WCHAR -> Uint16
// w2 : WCHAR -> Uint16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ChrCmpIW(
  w1: WideChar;   // WCHAR
  w2: WideChar   // WCHAR
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'ChrCmpIW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ChrCmpIW"
  c_ChrCmpIW :: Word16 -> Word16 -> IO CInt
-- w1 : WCHAR -> Word16
-- w2 : WCHAR -> Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let chrcmpiw =
  foreign "ChrCmpIW"
    (uint16_t @-> uint16_t @-> returning int32_t)
(* w1 : WCHAR -> uint16_t *)
(* w2 : WCHAR -> uint16_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("ChrCmpIW" chr-cmp-iw :convention :stdcall) :int32
  (w1 :uint16)   ; WCHAR
  (w2 :uint16))   ; WCHAR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ChrCmpIW = Win32::API::More->new('SHLWAPI',
    'BOOL ChrCmpIW(WORD w1, WORD w2)');
# my $ret = $ChrCmpIW->Call($w1, $w2);
# w1 : WCHAR -> WORD
# w2 : WCHAR -> WORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い