StrCmpNICW
関数シグネチャ
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
INT StrCmpNICW(
LPCWSTR pszStr1,
LPCWSTR pszStr2,
INT nChar
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszStr1 | LPCWSTR | in | 比較対象となる 1 つ目の null 終端文字列へのポインターです。 |
| pszStr2 | LPCWSTR | in | 比較対象となる 2 つ目の null 終端文字列へのポインターです。 |
| nChar | INT | in | 各文字列の先頭から比較する文字数です。 |
戻り値の型: INT
公式ドキュメント
2 つの文字列の先頭から指定された文字数を、C ランタイム (ASCII) の照合規則を使用して比較します。比較では大文字と小文字は区別されません。(Unicode)
戻り値
型: int
部分文字列が同一の場合は 0 を返します。pszStr1 が指す文字列から取り出した文字列が、pszStr2 が指す文字列から取り出した文字列よりもアルファベット順で大きい場合は正の値を返します。pszStr1 が指す文字列から取り出した文字列が、pszStr2 が指す文字列から取り出した文字列よりもアルファベット順で小さい場合は負の値を返します。
解説(Remarks)
StrCmpNIC は正規化された文字列の比較を目的として設計されている点に注意してください。これらの文字列はローカライズされておらず、ASCII 値 128 未満の文字のみで構成されます。そのため、ダブルバイト文字セット (DBCS) やその他のマルチキャラクターデータでは正しく動作しません。
この関数は最初に一致しない文字を見つけ、1 つ目の文字列の文字が 2 つ目の文字列の文字より大きい場合は正の数を、小さい場合は負の数を、等しい場合は 0 を返します。たとえば、pszStr1="abczb"、pszStr2="abcdefg" とし、各文字列の先頭から 4 文字を比較するとします。StrCmpNIC は最初に一致しない文字が 4 番目の位置 (pszStr1 の "z" と pszStr2 の "d") にあると判断し、"z" の ASCII コードが "d" の ASCII コードより大きいため正の値を返します。
Shlwapi.h に StrCmpNIC が含まれていないバージョンの Windows では、この関数の ANSI 版または Unicode 版を Shlwapi.dll から直接呼び出す必要があります。StrCmpNICA は序数 153、StrCmpNICW は序数 154 です。
shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして StrCmpNIC を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (Unicode / -W)
#include <windows.h>
INT StrCmpNICW(
LPCWSTR pszStr1,
LPCWSTR pszStr2,
INT nChar
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int StrCmpNICW(
[MarshalAs(UnmanagedType.LPWStr)] string pszStr1, // LPCWSTR
[MarshalAs(UnmanagedType.LPWStr)] string pszStr2, // LPCWSTR
int nChar // INT
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function StrCmpNICW(
<MarshalAs(UnmanagedType.LPWStr)> pszStr1 As String, ' LPCWSTR
<MarshalAs(UnmanagedType.LPWStr)> pszStr2 As String, ' LPCWSTR
nChar As Integer ' INT
) As Integer
End Function' pszStr1 : LPCWSTR
' pszStr2 : LPCWSTR
' nChar : INT
Declare PtrSafe Function StrCmpNICW Lib "shlwapi" ( _
ByVal pszStr1 As LongPtr, _
ByVal pszStr2 As LongPtr, _
ByVal nChar 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
StrCmpNICW = ctypes.windll.shlwapi.StrCmpNICW
StrCmpNICW.restype = ctypes.c_int
StrCmpNICW.argtypes = [
wintypes.LPCWSTR, # pszStr1 : LPCWSTR
wintypes.LPCWSTR, # pszStr2 : LPCWSTR
ctypes.c_int, # nChar : INT
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
StrCmpNICW = Fiddle::Function.new(
lib['StrCmpNICW'],
[
Fiddle::TYPE_VOIDP, # pszStr1 : LPCWSTR
Fiddle::TYPE_VOIDP, # pszStr2 : LPCWSTR
Fiddle::TYPE_INT, # nChar : INT
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "shlwapi")]
extern "system" {
fn StrCmpNICW(
pszStr1: *const u16, // LPCWSTR
pszStr2: *const u16, // LPCWSTR
nChar: i32 // INT
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern int StrCmpNICW([MarshalAs(UnmanagedType.LPWStr)] string pszStr1, [MarshalAs(UnmanagedType.LPWStr)] string pszStr2, int nChar);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrCmpNICW' -Namespace Win32 -PassThru
# $api::StrCmpNICW(pszStr1, pszStr2, nChar)#uselib "SHLWAPI.dll"
#func global StrCmpNICW "StrCmpNICW" wptr, wptr, wptr
; StrCmpNICW pszStr1, pszStr2, nChar ; 戻り値は stat
; pszStr1 : LPCWSTR -> "wptr"
; pszStr2 : LPCWSTR -> "wptr"
; nChar : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll"
#cfunc global StrCmpNICW "StrCmpNICW" wstr, wstr, int
; res = StrCmpNICW(pszStr1, pszStr2, nChar)
; pszStr1 : LPCWSTR -> "wstr"
; pszStr2 : LPCWSTR -> "wstr"
; nChar : INT -> "int"; INT StrCmpNICW(LPCWSTR pszStr1, LPCWSTR pszStr2, INT nChar)
#uselib "SHLWAPI.dll"
#cfunc global StrCmpNICW "StrCmpNICW" wstr, wstr, int
; res = StrCmpNICW(pszStr1, pszStr2, nChar)
; pszStr1 : LPCWSTR -> "wstr"
; pszStr2 : LPCWSTR -> "wstr"
; nChar : INT -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procStrCmpNICW = shlwapi.NewProc("StrCmpNICW")
)
// pszStr1 (LPCWSTR), pszStr2 (LPCWSTR), nChar (INT)
r1, _, err := procStrCmpNICW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszStr1))),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszStr2))),
uintptr(nChar),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction StrCmpNICW(
pszStr1: PWideChar; // LPCWSTR
pszStr2: PWideChar; // LPCWSTR
nChar: Integer // INT
): Integer; stdcall;
external 'SHLWAPI.dll' name 'StrCmpNICW';result := DllCall("SHLWAPI\StrCmpNICW"
, "WStr", pszStr1 ; LPCWSTR
, "WStr", pszStr2 ; LPCWSTR
, "Int", nChar ; INT
, "Int") ; return: INT●StrCmpNICW(pszStr1, pszStr2, nChar) = DLL("SHLWAPI.dll", "int StrCmpNICW(char*, char*, int)")
# 呼び出し: StrCmpNICW(pszStr1, pszStr2, nChar)
# pszStr1 : LPCWSTR -> "char*"
# pszStr2 : LPCWSTR -> "char*"
# nChar : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "shlwapi" fn StrCmpNICW(
pszStr1: [*c]const u16, // LPCWSTR
pszStr2: [*c]const u16, // LPCWSTR
nChar: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc StrCmpNICW(
pszStr1: WideCString, # LPCWSTR
pszStr2: WideCString, # LPCWSTR
nChar: int32 # INT
): int32 {.importc: "StrCmpNICW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shlwapi");
extern(Windows)
int StrCmpNICW(
const(wchar)* pszStr1, // LPCWSTR
const(wchar)* pszStr2, // LPCWSTR
int nChar // INT
);ccall((:StrCmpNICW, "SHLWAPI.dll"), stdcall, Int32,
(Cwstring, Cwstring, Int32),
pszStr1, pszStr2, nChar)
# pszStr1 : LPCWSTR -> Cwstring
# pszStr2 : LPCWSTR -> Cwstring
# nChar : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t StrCmpNICW(
const uint16_t* pszStr1,
const uint16_t* pszStr2,
int32_t nChar);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.StrCmpNICW(pszStr1, pszStr2, nChar)
-- pszStr1 : LPCWSTR
-- pszStr2 : LPCWSTR
-- nChar : 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('SHLWAPI.dll');
const StrCmpNICW = lib.func('__stdcall', 'StrCmpNICW', 'int32_t', ['str16', 'str16', 'int32_t']);
// StrCmpNICW(pszStr1, pszStr2, nChar)
// pszStr1 : LPCWSTR -> 'str16'
// pszStr2 : LPCWSTR -> 'str16'
// nChar : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
StrCmpNICW: { parameters: ["buffer", "buffer", "i32"], result: "i32" },
});
// lib.symbols.StrCmpNICW(pszStr1, pszStr2, nChar)
// pszStr1 : LPCWSTR -> "buffer"
// pszStr2 : LPCWSTR -> "buffer"
// nChar : INT -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t StrCmpNICW(
const uint16_t* pszStr1,
const uint16_t* pszStr2,
int32_t nChar);
C, "SHLWAPI.dll");
// $ffi->StrCmpNICW(pszStr1, pszStr2, nChar);
// pszStr1 : LPCWSTR
// pszStr2 : LPCWSTR
// nChar : 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 Shlwapi extends StdCallLibrary {
Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.UNICODE_OPTIONS);
int StrCmpNICW(
WString pszStr1, // LPCWSTR
WString pszStr2, // LPCWSTR
int nChar // INT
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shlwapi")]
lib LibSHLWAPI
fun StrCmpNICW = StrCmpNICW(
pszStr1 : UInt16*, # LPCWSTR
pszStr2 : UInt16*, # LPCWSTR
nChar : 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 StrCmpNICWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Int32);
typedef StrCmpNICWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int);
final StrCmpNICW = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<StrCmpNICWNative, StrCmpNICWDart>('StrCmpNICW');
// pszStr1 : LPCWSTR -> Pointer<Utf16>
// pszStr2 : LPCWSTR -> Pointer<Utf16>
// nChar : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function StrCmpNICW(
pszStr1: PWideChar; // LPCWSTR
pszStr2: PWideChar; // LPCWSTR
nChar: Integer // INT
): Integer; stdcall;
external 'SHLWAPI.dll' name 'StrCmpNICW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "StrCmpNICW"
c_StrCmpNICW :: CWString -> CWString -> Int32 -> IO Int32
-- pszStr1 : LPCWSTR -> CWString
-- pszStr2 : LPCWSTR -> CWString
-- nChar : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let strcmpnicw =
foreign "StrCmpNICW"
((ptr uint16_t) @-> (ptr uint16_t) @-> int32_t @-> returning int32_t)
(* pszStr1 : LPCWSTR -> (ptr uint16_t) *)
(* pszStr2 : LPCWSTR -> (ptr uint16_t) *)
(* nChar : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)
(cffi:defcfun ("StrCmpNICW" str-cmp-nicw :convention :stdcall) :int32
(psz-str1 (:string :encoding :utf-16le)) ; LPCWSTR
(psz-str2 (:string :encoding :utf-16le)) ; LPCWSTR
(n-char :int32)) ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $StrCmpNICW = Win32::API::More->new('SHLWAPI',
'int StrCmpNICW(LPCWSTR pszStr1, LPCWSTR pszStr2, int nChar)');
# my $ret = $StrCmpNICW->Call($pszStr1, $pszStr2, $nChar);
# pszStr1 : LPCWSTR -> LPCWSTR
# pszStr2 : LPCWSTR -> LPCWSTR
# nChar : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f StrCmpNICA (ANSI版) — Cロケールで指定文字数を大小文字無視して比較する。
- f CompareStringW — ロケールに従い二つのUnicode文字列を比較する。
- f StrCmpICW — C言語ロケールで大小文字無視して文字列を比較する。
- f StrCmpNIW — 指定文字数だけ大小文字を区別せず文字列を比較する。