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

StrCmpICW

関数
C言語ロケールで大小文字無視して文字列を比較する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT StrCmpICW(
    LPCWSTR pszStr1,
    LPCWSTR pszStr2
);

パラメーター

名前方向説明
pszStr1LPCWSTRin比較対象となる最初の null 終端文字列へのポインター。
pszStr2LPCWSTRin比較対象となる 2 番目の null 終端文字列へのポインター。

戻り値の型: INT

公式ドキュメント

C ランタイム (ASCII) の照合規則を使用して 2 つの文字列を比較します。比較では大文字と小文字は区別されません。(Unicode)

戻り値

型: int

文字列が同一の場合は 0 を返します。lpStr1 が指す文字列が lpStr2 が指す文字列よりもアルファベット順で大きい場合は正の値を返します。lpStr1 が指す文字列が lpStr2 が指す文字列よりもアルファベット順で小さい場合は負の値を返します。

解説(Remarks)

この関数の代わりに CompareString を使用することを強く推奨します。StrCmpIC は正規化された文字列の比較用に設計されています。これらの文字列はローカライズされておらず、ASCII 値 128 未満の文字のみで構成されます。そのため、ダブルバイト文字セット (DBCS) のデータでは正しく機能しません。

大文字は比較前に小文字へ変換され、変換後の値の比較に基づいて戻り値が決まります。この関数は、最初に見つかった不一致の文字どうしの値の差を返します。すべての文字が等しい場合は 0 を返します。たとえば lpStr1="abczb"、lpStr2="abcdefg" の場合、StrCmpIC は "abczb" が "abcdefg" より大きいと判定し、z - d を返します。

Shlwapi.h に StrCmpIC が含まれていないバージョンの Windows では、この関数の ANSI 版または Unicode 版を Shlwapi.dll から直接呼び出す必要があります。StrCmpICA は序数 157、StrCmpICW は序数 158 です。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

INT StrCmpICW(
    LPCWSTR pszStr1,
    LPCWSTR pszStr2
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int StrCmpICW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszStr1,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pszStr2   // LPCWSTR
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function StrCmpICW(
    <MarshalAs(UnmanagedType.LPWStr)> pszStr1 As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszStr2 As String   ' LPCWSTR
) As Integer
End Function
' pszStr1 : LPCWSTR
' pszStr2 : LPCWSTR
Declare PtrSafe Function StrCmpICW Lib "shlwapi" ( _
    ByVal pszStr1 As LongPtr, _
    ByVal pszStr2 As LongPtr) 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

StrCmpICW = ctypes.windll.shlwapi.StrCmpICW
StrCmpICW.restype = ctypes.c_int
StrCmpICW.argtypes = [
    wintypes.LPCWSTR,  # pszStr1 : LPCWSTR
    wintypes.LPCWSTR,  # pszStr2 : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procStrCmpICW = shlwapi.NewProc("StrCmpICW")
)

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

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

typedef StrCmpICWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>);
typedef StrCmpICWDart = int Function(Pointer<Utf16>, Pointer<Utf16>);
final StrCmpICW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<StrCmpICWNative, StrCmpICWDart>('StrCmpICW');
// pszStr1 : LPCWSTR -> Pointer<Utf16>
// pszStr2 : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StrCmpICW(
  pszStr1: PWideChar;   // LPCWSTR
  pszStr2: PWideChar   // LPCWSTR
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'StrCmpICW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "StrCmpICW"
  c_StrCmpICW :: CWString -> CWString -> IO Int32
-- pszStr1 : LPCWSTR -> CWString
-- pszStr2 : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("StrCmpICW" str-cmp-icw :convention :stdcall) :int32
  (psz-str1 (:string :encoding :utf-16le))   ; LPCWSTR
  (psz-str2 (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StrCmpICW = Win32::API::More->new('SHLWAPI',
    'int StrCmpICW(LPCWSTR pszStr1, LPCWSTR pszStr2)');
# my $ret = $StrCmpICW->Call($pszStr1, $pszStr2);
# pszStr1 : LPCWSTR -> LPCWSTR
# pszStr2 : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目