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

lstrcmpiA

関数
二つのANSI文字列を大文字小文字無視で比較する。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT lstrcmpiA(
    LPCSTR lpString1,
    LPCSTR lpString2
);

パラメーター

名前方向説明
lpString1LPCSTRin比較する 1 つ目の null で終わる文字列。
lpString2LPCSTRin比較する 2 つ目の null で終わる文字列。

戻り値の型: INT

公式ドキュメント

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

戻り値

型: int

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

解説(Remarks)

lstrcmpi 関数は、2 つの文字列の先頭文字どうし、2 番目の文字どうし、というように、不一致が見つかるか文字列の末尾に達するまで順に比較します。

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

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

一部のロケールでは、lstrcmpi 関数では不十分な場合があります。その場合は、CompareStringEx を使用して適切な比較を行ってください。たとえば日本語環境では、最も適切な非厳密文字列比較を行うために、NORM_IGNORECASENORM_IGNOREKANATYPENORM_IGNOREWIDTH の値を指定して呼び出します。NORM_IGNOREKANATYPENORM_IGNOREWIDTH の値は非アジア系ロケールでは無視されるため、すべてのロケールでこれらの値を設定しておけば、ロケールに関係なく文化的に正しい「区別しない」並べ替えが保証されます。ただし、これらの値を指定するとパフォーマンスが低下するため、必要な場合にのみ使用してください。

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

lstrcmpi 関数は、文字列ソートではなくワードソートを使用します。ワードソートは、"coop" や "co-op" のような語が並べ替えられたリスト内で一緒に保たれるように、ハイフンやアポストロフィを他の英数字以外の記号とは異なる方法で扱います。ワードソートと文字列ソートの詳細については、Handling Sorting in Your Applications を参照してください。

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

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

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

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

各言語での呼び出し定義

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

INT lstrcmpiA(
    LPCSTR lpString1,
    LPCSTR lpString2
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int lstrcmpiA(
    [MarshalAs(UnmanagedType.LPStr)] string lpString1,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpString2   // LPCSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function lstrcmpiA(
    <MarshalAs(UnmanagedType.LPStr)> lpString1 As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpString2 As String   ' LPCSTR
) As Integer
End Function
' lpString1 : LPCSTR
' lpString2 : LPCSTR
Declare PtrSafe Function lstrcmpiA Lib "kernel32" ( _
    ByVal lpString1 As String, _
    ByVal lpString2 As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	proclstrcmpiA = kernel32.NewProc("lstrcmpiA")
)

// lpString1 (LPCSTR), lpString2 (LPCSTR)
r1, _, err := proclstrcmpiA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpString1))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpString2))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function lstrcmpiA(
  lpString1: PAnsiChar;   // LPCSTR
  lpString2: PAnsiChar   // LPCSTR
): Integer; stdcall;
  external 'KERNEL32.dll' name 'lstrcmpiA';
result := DllCall("KERNEL32\lstrcmpiA"
    , "AStr", lpString1   ; LPCSTR
    , "AStr", lpString2   ; LPCSTR
    , "Int")   ; return: INT
●lstrcmpiA(lpString1, lpString2) = DLL("KERNEL32.dll", "int lstrcmpiA(char*, char*)")
# 呼び出し: lstrcmpiA(lpString1, lpString2)
# lpString1 : LPCSTR -> "char*"
# lpString2 : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef lstrcmpiANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>);
typedef lstrcmpiADart = int Function(Pointer<Utf8>, Pointer<Utf8>);
final lstrcmpiA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<lstrcmpiANative, lstrcmpiADart>('lstrcmpiA');
// lpString1 : LPCSTR -> Pointer<Utf8>
// lpString2 : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function lstrcmpiA(
  lpString1: PAnsiChar;   // LPCSTR
  lpString2: PAnsiChar   // LPCSTR
): Integer; stdcall;
  external 'KERNEL32.dll' name 'lstrcmpiA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("lstrcmpiA" lstrcmpi-a :convention :stdcall) :int32
  (lp-string1 :string)   ; LPCSTR
  (lp-string2 :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $lstrcmpiA = Win32::API::More->new('KERNEL32',
    'int lstrcmpiA(LPCSTR lpString1, LPCSTR lpString2)');
# my $ret = $lstrcmpiA->Call($lpString1, $lpString2);
# lpString1 : LPCSTR -> LPCSTR
# lpString2 : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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