lstrcmpA
関数シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
INT lstrcmpA(
LPCSTR lpString1,
LPCSTR lpString2
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpString1 | LPCSTR | in | 比較する 1 つ目の null 終端文字列。 |
| lpString2 | LPCSTR | in | 比較する 2 つ目の null 終端文字列。 |
戻り値の型: INT
公式ドキュメント
2 つの文字列を比較します。比較では大文字と小文字が区別されます。(ANSI)
戻り値
型: int
lpString1 が指す文字列が lpString2 が指す文字列より小さい場合、戻り値は負の値になります。lpString1 が指す文字列が lpString2 が指す文字列より大きい場合、戻り値は正の値になります。文字列が等しい場合、戻り値は 0 になります。
解説(Remarks)
lstrcmp 関数は、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 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
INT lstrcmpA(
LPCSTR lpString1,
LPCSTR lpString2
);[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int lstrcmpA(
[MarshalAs(UnmanagedType.LPStr)] string lpString1, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] string lpString2 // LPCSTR
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function lstrcmpA(
<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 lstrcmpA 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
lstrcmpA = ctypes.windll.kernel32.lstrcmpA
lstrcmpA.restype = ctypes.c_int
lstrcmpA.argtypes = [
wintypes.LPCSTR, # lpString1 : LPCSTR
wintypes.LPCSTR, # lpString2 : LPCSTR
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
lstrcmpA = Fiddle::Function.new(
lib['lstrcmpA'],
[
Fiddle::TYPE_VOIDP, # lpString1 : LPCSTR
Fiddle::TYPE_VOIDP, # lpString2 : LPCSTR
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn lstrcmpA(
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 lstrcmpA([MarshalAs(UnmanagedType.LPStr)] string lpString1, [MarshalAs(UnmanagedType.LPStr)] string lpString2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_lstrcmpA' -Namespace Win32 -PassThru
# $api::lstrcmpA(lpString1, lpString2)#uselib "KERNEL32.dll"
#func global lstrcmpA "lstrcmpA" sptr, sptr
; lstrcmpA lpString1, lpString2 ; 戻り値は stat
; lpString1 : LPCSTR -> "sptr"
; lpString2 : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global lstrcmpA "lstrcmpA" str, str
; res = lstrcmpA(lpString1, lpString2)
; lpString1 : LPCSTR -> "str"
; lpString2 : LPCSTR -> "str"; INT lstrcmpA(LPCSTR lpString1, LPCSTR lpString2)
#uselib "KERNEL32.dll"
#cfunc global lstrcmpA "lstrcmpA" str, str
; res = lstrcmpA(lpString1, lpString2)
; lpString1 : LPCSTR -> "str"
; lpString2 : LPCSTR -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
proclstrcmpA = kernel32.NewProc("lstrcmpA")
)
// lpString1 (LPCSTR), lpString2 (LPCSTR)
r1, _, err := proclstrcmpA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpString1))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpString2))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction lstrcmpA(
lpString1: PAnsiChar; // LPCSTR
lpString2: PAnsiChar // LPCSTR
): Integer; stdcall;
external 'KERNEL32.dll' name 'lstrcmpA';result := DllCall("KERNEL32\lstrcmpA"
, "AStr", lpString1 ; LPCSTR
, "AStr", lpString2 ; LPCSTR
, "Int") ; return: INT●lstrcmpA(lpString1, lpString2) = DLL("KERNEL32.dll", "int lstrcmpA(char*, char*)")
# 呼び出し: lstrcmpA(lpString1, lpString2)
# lpString1 : LPCSTR -> "char*"
# lpString2 : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn lstrcmpA(
lpString1: [*c]const u8, // LPCSTR
lpString2: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;proc lstrcmpA(
lpString1: cstring, # LPCSTR
lpString2: cstring # LPCSTR
): int32 {.importc: "lstrcmpA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int lstrcmpA(
const(char)* lpString1, // LPCSTR
const(char)* lpString2 // LPCSTR
);ccall((:lstrcmpA, "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 lstrcmpA(
const char* lpString1,
const char* lpString2);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.lstrcmpA(lpString1, lpString2)
-- lpString1 : LPCSTR
-- lpString2 : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const lstrcmpA = lib.func('__stdcall', 'lstrcmpA', 'int32_t', ['str', 'str']);
// lstrcmpA(lpString1, lpString2)
// lpString1 : LPCSTR -> 'str'
// lpString2 : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
lstrcmpA: { parameters: ["buffer", "buffer"], result: "i32" },
});
// lib.symbols.lstrcmpA(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 lstrcmpA(
const char* lpString1,
const char* lpString2);
C, "KERNEL32.dll");
// $ffi->lstrcmpA(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 lstrcmpA(
String lpString1, // LPCSTR
String lpString2 // LPCSTR
);
}@[Link("kernel32")]
lib LibKERNEL32
fun lstrcmpA = lstrcmpA(
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 lstrcmpANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>);
typedef lstrcmpADart = int Function(Pointer<Utf8>, Pointer<Utf8>);
final lstrcmpA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<lstrcmpANative, lstrcmpADart>('lstrcmpA');
// lpString1 : LPCSTR -> Pointer<Utf8>
// lpString2 : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function lstrcmpA(
lpString1: PAnsiChar; // LPCSTR
lpString2: PAnsiChar // LPCSTR
): Integer; stdcall;
external 'KERNEL32.dll' name 'lstrcmpA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "lstrcmpA"
c_lstrcmpA :: CString -> CString -> IO Int32
-- lpString1 : LPCSTR -> CString
-- lpString2 : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let lstrcmpa =
foreign "lstrcmpA"
(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 ("lstrcmpA" lstrcmp-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 $lstrcmpA = Win32::API::More->new('KERNEL32',
'int lstrcmpA(LPCSTR lpString1, LPCSTR lpString2)');
# my $ret = $lstrcmpA->Call($lpString1, $lpString2);
# lpString1 : LPCSTR -> LPCSTR
# lpString2 : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f lstrcmpW (Unicode版) — 二つのワイド文字列をロケール準拠で比較する。
- f CompareStringA — ロケールに従い二つのANSI文字列を比較する。
- f CompareStringEx — ロケール名を指定して二つの文字列を比較する。
- f CompareStringOrdinal — 二つの文字列を序数的に比較する。
- f lstrcatA — ANSI文字列を末尾に連結する。
- f lstrcmpiA — 二つのANSI文字列を大文字小文字無視で比較する。
- f lstrcpyA — ANSI文字列を別バッファへ複写する。
- f lstrlenA — ANSI文字列の文字数を取得する。