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