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

ChrCmpIA

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

シグネチャ

// SHLWAPI.dll  (ANSI / -A)
#include <windows.h>

BOOL ChrCmpIA(
    WORD w1,
    WORD w2
);

パラメーター

名前方向説明
w1WORDin比較する1つ目の文字。
w2WORDin比較する2つ目の文字。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: 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  (ANSI / -A)
#include <windows.h>

BOOL ChrCmpIA(
    WORD w1,
    WORD w2
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool ChrCmpIA(
    ushort w1,   // WORD
    ushort w2   // WORD
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ChrCmpIA(
    w1 As UShort,   ' WORD
    w2 As UShort   ' WORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' w1 : WORD
' w2 : WORD
Declare PtrSafe Function ChrCmpIA Lib "shlwapi" ( _
    ByVal w1 As Integer, _
    ByVal w2 As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ChrCmpIA = ctypes.windll.shlwapi.ChrCmpIA
ChrCmpIA.restype = wintypes.BOOL
ChrCmpIA.argtypes = [
    ctypes.c_ushort,  # w1 : WORD
    ctypes.c_ushort,  # w2 : WORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procChrCmpIA = shlwapi.NewProc("ChrCmpIA")
)

// w1 (WORD), w2 (WORD)
r1, _, err := procChrCmpIA.Call(
	uintptr(w1),
	uintptr(w2),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ChrCmpIA(
  w1: Word;   // WORD
  w2: Word   // WORD
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'ChrCmpIA';
result := DllCall("SHLWAPI\ChrCmpIA"
    , "UShort", w1   ; WORD
    , "UShort", w2   ; WORD
    , "Int")   ; return: BOOL
●ChrCmpIA(w1, w2) = DLL("SHLWAPI.dll", "bool ChrCmpIA(int, int)")
# 呼び出し: ChrCmpIA(w1, w2)
# w1 : WORD -> "int"
# w2 : WORD -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shlwapi" fn ChrCmpIA(
    w1: u16, // WORD
    w2: u16 // WORD
) callconv(std.os.windows.WINAPI) i32;
proc ChrCmpIA(
    w1: uint16,  # WORD
    w2: uint16  # WORD
): int32 {.importc: "ChrCmpIA", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
int ChrCmpIA(
    ushort w1,   // WORD
    ushort w2   // WORD
);
ccall((:ChrCmpIA, "SHLWAPI.dll"), stdcall, Int32,
      (UInt16, UInt16),
      w1, w2)
# w1 : WORD -> UInt16
# w2 : WORD -> UInt16
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ChrCmpIA(
    uint16_t w1,
    uint16_t w2);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.ChrCmpIA(w1, w2)
-- w1 : WORD
-- w2 : WORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const ChrCmpIA = lib.func('__stdcall', 'ChrCmpIA', 'int32_t', ['uint16_t', 'uint16_t']);
// ChrCmpIA(w1, w2)
// w1 : WORD -> 'uint16_t'
// w2 : WORD -> 'uint16_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  ChrCmpIA: { parameters: ["u16", "u16"], result: "i32" },
});
// lib.symbols.ChrCmpIA(w1, w2)
// w1 : WORD -> "u16"
// w2 : WORD -> "u16"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ChrCmpIA(
    uint16_t w1,
    uint16_t w2);
C, "SHLWAPI.dll");
// $ffi->ChrCmpIA(w1, w2);
// w1 : WORD
// w2 : WORD
// 構造体/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.ASCII_OPTIONS);
    boolean ChrCmpIA(
        short w1,   // WORD
        short w2   // WORD
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun ChrCmpIA = ChrCmpIA(
    w1 : UInt16,   # WORD
    w2 : UInt16   # WORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

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

関連項目

文字セット違い