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

StrCmpNIW

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

シグネチャ

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

INT StrCmpNIW(
    LPCWSTR psz1,
    LPCWSTR psz2,
    INT nChar
);

パラメーター

名前方向説明
psz1LPCWSTRin比較する 1 つ目の null 終端文字列へのポインター。
psz2LPCWSTRin比較する 2 つ目の null 終端文字列へのポインター。
nCharINTin各文字列の先頭から比較する文字数。

戻り値の型: INT

公式ドキュメント

2 つの文字列の先頭から指定した文字数を比較し、それらが同一かどうかを判定します。比較では大文字と小文字は区別されません。StrNCmpI マクロは、この関数と名前が異なるだけです。(Unicode)

戻り値

型: int

文字列が同一の場合は 0 を返します。psz1 が指す文字列の先頭 nChar 文字が psz2 が指す文字列のものより大きい場合は正の値を返します。psz1 が指す文字列の先頭 nChar 文字が psz2 が指す文字列のものより小さい場合は負の値を返します。

解説(Remarks)

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして StrCmpNI を定義します。エンコーディング中立なエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイル エラーや実行時エラーを引き起こす可能性があります。詳細については、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 StrCmpNIW(
    LPCWSTR psz1,
    LPCWSTR psz2,
    INT nChar
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int StrCmpNIW(
    [MarshalAs(UnmanagedType.LPWStr)] string psz1,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string psz2,   // LPCWSTR
    int nChar   // INT
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function StrCmpNIW(
    <MarshalAs(UnmanagedType.LPWStr)> psz1 As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> psz2 As String,   ' LPCWSTR
    nChar As Integer   ' INT
) As Integer
End Function
' psz1 : LPCWSTR
' psz2 : LPCWSTR
' nChar : INT
Declare PtrSafe Function StrCmpNIW Lib "shlwapi" ( _
    ByVal psz1 As LongPtr, _
    ByVal psz2 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

StrCmpNIW = ctypes.windll.shlwapi.StrCmpNIW
StrCmpNIW.restype = ctypes.c_int
StrCmpNIW.argtypes = [
    wintypes.LPCWSTR,  # psz1 : LPCWSTR
    wintypes.LPCWSTR,  # psz2 : LPCWSTR
    ctypes.c_int,  # nChar : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
StrCmpNIW = Fiddle::Function.new(
  lib['StrCmpNIW'],
  [
    Fiddle::TYPE_VOIDP,  # psz1 : LPCWSTR
    Fiddle::TYPE_VOIDP,  # psz2 : LPCWSTR
    Fiddle::TYPE_INT,  # nChar : INT
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn StrCmpNIW(
        psz1: *const u16,  // LPCWSTR
        psz2: *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 StrCmpNIW([MarshalAs(UnmanagedType.LPWStr)] string psz1, [MarshalAs(UnmanagedType.LPWStr)] string psz2, int nChar);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrCmpNIW' -Namespace Win32 -PassThru
# $api::StrCmpNIW(psz1, psz2, nChar)
#uselib "SHLWAPI.dll"
#func global StrCmpNIW "StrCmpNIW" wptr, wptr, wptr
; StrCmpNIW psz1, psz2, nChar   ; 戻り値は stat
; psz1 : LPCWSTR -> "wptr"
; psz2 : LPCWSTR -> "wptr"
; nChar : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global StrCmpNIW "StrCmpNIW" wstr, wstr, int
; res = StrCmpNIW(psz1, psz2, nChar)
; psz1 : LPCWSTR -> "wstr"
; psz2 : LPCWSTR -> "wstr"
; nChar : INT -> "int"
; INT StrCmpNIW(LPCWSTR psz1, LPCWSTR psz2, INT nChar)
#uselib "SHLWAPI.dll"
#cfunc global StrCmpNIW "StrCmpNIW" wstr, wstr, int
; res = StrCmpNIW(psz1, psz2, nChar)
; psz1 : LPCWSTR -> "wstr"
; psz2 : LPCWSTR -> "wstr"
; nChar : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procStrCmpNIW = shlwapi.NewProc("StrCmpNIW")
)

// psz1 (LPCWSTR), psz2 (LPCWSTR), nChar (INT)
r1, _, err := procStrCmpNIW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(psz1))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(psz2))),
	uintptr(nChar),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function StrCmpNIW(
  psz1: PWideChar;   // LPCWSTR
  psz2: PWideChar;   // LPCWSTR
  nChar: Integer   // INT
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'StrCmpNIW';
result := DllCall("SHLWAPI\StrCmpNIW"
    , "WStr", psz1   ; LPCWSTR
    , "WStr", psz2   ; LPCWSTR
    , "Int", nChar   ; INT
    , "Int")   ; return: INT
●StrCmpNIW(psz1, psz2, nChar) = DLL("SHLWAPI.dll", "int StrCmpNIW(char*, char*, int)")
# 呼び出し: StrCmpNIW(psz1, psz2, nChar)
# psz1 : LPCWSTR -> "char*"
# psz2 : 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 StrCmpNIW(
    psz1: [*c]const u16, // LPCWSTR
    psz2: [*c]const u16, // LPCWSTR
    nChar: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc StrCmpNIW(
    psz1: WideCString,  # LPCWSTR
    psz2: WideCString,  # LPCWSTR
    nChar: int32  # INT
): int32 {.importc: "StrCmpNIW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
int StrCmpNIW(
    const(wchar)* psz1,   // LPCWSTR
    const(wchar)* psz2,   // LPCWSTR
    int nChar   // INT
);
ccall((:StrCmpNIW, "SHLWAPI.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Int32),
      psz1, psz2, nChar)
# psz1 : LPCWSTR -> Cwstring
# psz2 : LPCWSTR -> Cwstring
# nChar : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t StrCmpNIW(
    const uint16_t* psz1,
    const uint16_t* psz2,
    int32_t nChar);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.StrCmpNIW(psz1, psz2, nChar)
-- psz1 : LPCWSTR
-- psz2 : 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 StrCmpNIW = lib.func('__stdcall', 'StrCmpNIW', 'int32_t', ['str16', 'str16', 'int32_t']);
// StrCmpNIW(psz1, psz2, nChar)
// psz1 : LPCWSTR -> 'str16'
// psz2 : LPCWSTR -> 'str16'
// nChar : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  StrCmpNIW: { parameters: ["buffer", "buffer", "i32"], result: "i32" },
});
// lib.symbols.StrCmpNIW(psz1, psz2, nChar)
// psz1 : LPCWSTR -> "buffer"
// psz2 : 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 StrCmpNIW(
    const uint16_t* psz1,
    const uint16_t* psz2,
    int32_t nChar);
C, "SHLWAPI.dll");
// $ffi->StrCmpNIW(psz1, psz2, nChar);
// psz1 : LPCWSTR
// psz2 : 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 StrCmpNIW(
        WString psz1,   // LPCWSTR
        WString psz2,   // LPCWSTR
        int nChar   // INT
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun StrCmpNIW = StrCmpNIW(
    psz1 : UInt16*,   # LPCWSTR
    psz2 : 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 StrCmpNIWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Int32);
typedef StrCmpNIWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int);
final StrCmpNIW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<StrCmpNIWNative, StrCmpNIWDart>('StrCmpNIW');
// psz1 : LPCWSTR -> Pointer<Utf16>
// psz2 : LPCWSTR -> Pointer<Utf16>
// nChar : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StrCmpNIW(
  psz1: PWideChar;   // LPCWSTR
  psz2: PWideChar;   // LPCWSTR
  nChar: Integer   // INT
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'StrCmpNIW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let strcmpniw =
  foreign "StrCmpNIW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> int32_t @-> returning int32_t)
(* psz1 : LPCWSTR -> (ptr uint16_t) *)
(* psz2 : 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 ("StrCmpNIW" str-cmp-niw :convention :stdcall) :int32
  (psz1 (:string :encoding :utf-16le))   ; LPCWSTR
  (psz2 (: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 $StrCmpNIW = Win32::API::More->new('SHLWAPI',
    'int StrCmpNIW(LPCWSTR psz1, LPCWSTR psz2, int nChar)');
# my $ret = $StrCmpNIW->Call($psz1, $psz2, $nChar);
# psz1 : LPCWSTR -> LPCWSTR
# psz2 : LPCWSTR -> LPCWSTR
# nChar : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い