Win32 API 日本語リファレンス
ホームGlobalization › lstrcmpW

lstrcmpW

関数
二つのワイド文字列をロケール準拠で比較する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT lstrcmpW(
    LPCWSTR lpString1,
    LPCWSTR lpString2
);

パラメーター

名前方向説明
lpString1LPCWSTRin比較対象となる 1 つ目の null 終端文字列です。
lpString2LPCWSTRin比較対象となる 2 つ目の null 終端文字列です。

戻り値の型: INT

公式ドキュメント

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

戻り値

型: int

lpString1 が指す文字列が lpString2 が指す文字列より小さい場合、戻り値は負の値になります。lpString1 が指す文字列が lpString2 が指す文字列より大きい場合、戻り値は正の値になります。文字列が等しい場合、戻り値は 0 になります。

解説(Remarks)

lstrcmp 関数は、2 つの文字列の先頭の文字どうし、2 番目の文字どうし、というように順に比較し、不一致が見つかるか、いずれかの文字列の終端に達するまで比較を続けます。

lpString1 および lpString2 の各パラメーターは null 終端である必要があることに注意してください。そうでない場合、文字列比較が正しく行われないことがあります。

この関数は、現在のスレッドのロケールを使用して CompareStringEx を呼び出し、文字列比較に関する C ランタイムの慣例に合わせるために、その結果から 2 を減算します。

どちらの文字列が大きいか (または文字列が同じかどうか) は、セットアップ時またはコントロール パネルでユーザーが選択した言語 (ユーザー ロケール) によって決まります。言語 (ユーザー ロケール) が選択されていない場合、システムは既定値を使用して比較を行います。

ダブルバイト文字セット (DBCS) 版のシステムでは、この関数で 2 つの DBCS 文字列を比較できます。

lstrcmp 関数は、文字列ソート (string sort) ではなくワードソート (word sort) を使用します。ワードソートでは、"coop" と "co-op" のような単語がソート済みリスト内でまとまるように、ハイフンやアポストロフィを、英数字以外のその他の記号とは異なる方法で扱います。ワードソートと文字列ソートの詳細については、Handling Sorting in Your Applications を参照してください。

セキュリティに関する注意事項

比較関数の選択に関するセキュリティ上の考慮事項については、Security Considerations: International Features を参照してください。
メモ

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

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

各言語での呼び出し定義

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

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

lstrcmpW = ctypes.windll.kernel32.lstrcmpW
lstrcmpW.restype = ctypes.c_int
lstrcmpW.argtypes = [
    wintypes.LPCWSTR,  # lpString1 : LPCWSTR
    wintypes.LPCWSTR,  # lpString2 : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	proclstrcmpW = kernel32.NewProc("lstrcmpW")
)

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

extern "kernel32" fn lstrcmpW(
    lpString1: [*c]const u16, // LPCWSTR
    lpString2: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc lstrcmpW(
    lpString1: WideCString,  # LPCWSTR
    lpString2: WideCString  # LPCWSTR
): int32 {.importc: "lstrcmpW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int lstrcmpW(
    const(wchar)* lpString1,   // LPCWSTR
    const(wchar)* lpString2   // LPCWSTR
);
ccall((:lstrcmpW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, Cwstring),
      lpString1, lpString2)
# lpString1 : LPCWSTR -> Cwstring
# lpString2 : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t lstrcmpW(
    const uint16_t* lpString1,
    const uint16_t* lpString2);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.lstrcmpW(lpString1, lpString2)
-- lpString1 : LPCWSTR
-- lpString2 : 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('KERNEL32.dll');
const lstrcmpW = lib.func('__stdcall', 'lstrcmpW', 'int32_t', ['str16', 'str16']);
// lstrcmpW(lpString1, lpString2)
// lpString1 : LPCWSTR -> 'str16'
// lpString2 : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  lstrcmpW: { parameters: ["buffer", "buffer"], result: "i32" },
});
// lib.symbols.lstrcmpW(lpString1, lpString2)
// lpString1 : LPCWSTR -> "buffer"
// lpString2 : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t lstrcmpW(
    const uint16_t* lpString1,
    const uint16_t* lpString2);
C, "KERNEL32.dll");
// $ffi->lstrcmpW(lpString1, lpString2);
// lpString1 : LPCWSTR
// lpString2 : 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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.UNICODE_OPTIONS);
    int lstrcmpW(
        WString lpString1,   // LPCWSTR
        WString lpString2   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun lstrcmpW = lstrcmpW(
    lpString1 : UInt16*,   # LPCWSTR
    lpString2 : 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 lstrcmpWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>);
typedef lstrcmpWDart = int Function(Pointer<Utf16>, Pointer<Utf16>);
final lstrcmpW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<lstrcmpWNative, lstrcmpWDart>('lstrcmpW');
// lpString1 : LPCWSTR -> Pointer<Utf16>
// lpString2 : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function lstrcmpW(
  lpString1: PWideChar;   // LPCWSTR
  lpString2: PWideChar   // LPCWSTR
): Integer; stdcall;
  external 'KERNEL32.dll' name 'lstrcmpW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let lstrcmpw =
  foreign "lstrcmpW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* lpString1 : LPCWSTR -> (ptr uint16_t) *)
(* lpString2 : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("lstrcmpW" lstrcmp-w :convention :stdcall) :int32
  (lp-string1 (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-string2 (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $lstrcmpW = Win32::API::More->new('KERNEL32',
    'int lstrcmpW(LPCWSTR lpString1, LPCWSTR lpString2)');
# my $ret = $lstrcmpW->Call($lpString1, $lpString2);
# lpString1 : LPCWSTR -> LPCWSTR
# lpString2 : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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