CompareStringA

関数

ロケールに従い二つのANSI文字列を比較する。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

COMPARESTRING_RESULT CompareStringA(
    DWORD Locale,
    DWORD dwCmpFlags,
    CHAR* lpString1,
    INT cchCount1,
    CHAR* lpString2,
    INT cchCount2
);

パラメーター

名前	型	方向	説明
Locale	DWORD	in	比較に使用するロケールのロケール識別子です。MAKELCID マクロを使用してロケール識別子を作成するか、次の定義済みの値のいずれかを使用できます。 LOCALE_CUSTOM_DEFAULT LOCALE_CUSTOM_UI_DEFAULT LOCALE_CUSTOM_UNSPECIFIED LOCALE_INVARIANT LOCALE_SYSTEM_DEFAULT LOCALE_USER_DEFAULT
dwCmpFlags	DWORD	in	この関数が 2 つの文字列をどのように比較するかを示すフラグです。詳細な定義については、CompareStringEx の dwCmpFlags パラメーターを参照してください。
lpString1	CHAR*	in	比較する 1 つ目の文字列へのポインターです。
cchCount1	INT	in	lpString1 で示される文字列の長さです。終端の null 文字は含みません。この値は、関数の ANSI 版ではバイト数を、Unicode 版ではワイド文字数を表します。文字列が null 終端である場合、アプリケーションは負の値を指定できます。この場合、関数が長さを自動的に判定します。
lpString2	CHAR*	in	比較する 2 つ目の文字列へのポインターです。
cchCount2	INT	in	lpString2 で示される文字列の長さです。終端の null 文字は含みません。この値は、関数の ANSI 版ではバイト数を、Unicode 版ではワイド文字数を表します。文字列が null 終端である場合、アプリケーションは負の値を指定できます。この場合、関数が長さを自動的に判定します。

戻り値の型: COMPARESTRING_RESULT

公式ドキュメント

識別子で指定したロケールに従って、2 つの文字列を比較します。注意 CompareString を誤って使用すると、アプリケーションのセキュリティが損なわれる可能性があります。(CompareStringA)

戻り値

CompareStringEx について説明されている値を返します。

解説(Remarks)

「解説」については CompareStringEx を参照してください。

アプリケーションが CompareString の ANSI 版を呼び出している場合、関数は指定されたロケールの既定のコードページを介してパラメーターを変換します。したがって、アプリケーションは CompareString を使用して UTF-8 テキストを扱うことはできません。

通常、大文字小文字を区別しない比較では、CompareString は、ロケールがトルコ語またはアゼルバイジャン語であっても、小文字の "i" を大文字の "I" にマッピングします。NORM_LINGUISTIC_CASING フラグはこの動作をトルコ語またはアゼルバイジャン語について上書きします。このフラグがトルコ語またはアゼルバイジャン語と併せて指定された場合、LATIN SMALL LETTER DOTLESS I (U+0131) が LATIN CAPITAL LETTER I (U+0049) の小文字形となり、LATIN SMALL LETTER I (U+0069) が LATIN CAPITAL LETTER I WITH DOT ABOVE (U+0130) の小文字形となります。

Windows 8 以降: この関数の ANSI 版は Winnls.h で宣言され、Unicode 版は Stringapiset.h で宣言されています。Windows 8 より前は、両方の版が Winnls.h で宣言されていました。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

COMPARESTRING_RESULT CompareStringA(
    DWORD Locale,
    DWORD dwCmpFlags,
    CHAR* lpString1,
    INT cchCount1,
    CHAR* lpString2,
    INT cchCount2
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int CompareStringA(
    uint Locale,   // DWORD
    uint dwCmpFlags,   // DWORD
    IntPtr lpString1,   // CHAR*
    int cchCount1,   // INT
    IntPtr lpString2,   // CHAR*
    int cchCount2   // INT
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function CompareStringA(
    Locale As UInteger,   ' DWORD
    dwCmpFlags As UInteger,   ' DWORD
    lpString1 As IntPtr,   ' CHAR*
    cchCount1 As Integer,   ' INT
    lpString2 As IntPtr,   ' CHAR*
    cchCount2 As Integer   ' INT
) As Integer
End Function

' Locale : DWORD
' dwCmpFlags : DWORD
' lpString1 : CHAR*
' cchCount1 : INT
' lpString2 : CHAR*
' cchCount2 : INT
Declare PtrSafe Function CompareStringA Lib "kernel32" ( _
    ByVal Locale As Long, _
    ByVal dwCmpFlags As Long, _
    ByVal lpString1 As LongPtr, _
    ByVal cchCount1 As Long, _
    ByVal lpString2 As LongPtr, _
    ByVal cchCount2 As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CompareStringA = ctypes.windll.kernel32.CompareStringA
CompareStringA.restype = ctypes.c_int
CompareStringA.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # dwCmpFlags : DWORD
    ctypes.POINTER(ctypes.c_byte),  # lpString1 : CHAR*
    ctypes.c_int,  # cchCount1 : INT
    ctypes.POINTER(ctypes.c_byte),  # lpString2 : CHAR*
    ctypes.c_int,  # cchCount2 : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CompareStringA = Fiddle::Function.new(
  lib['CompareStringA'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # dwCmpFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpString1 : CHAR*
    Fiddle::TYPE_INT,  # cchCount1 : INT
    Fiddle::TYPE_VOIDP,  # lpString2 : CHAR*
    Fiddle::TYPE_INT,  # cchCount2 : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn CompareStringA(
        Locale: u32,  // DWORD
        dwCmpFlags: u32,  // DWORD
        lpString1: *mut i8,  // CHAR*
        cchCount1: i32,  // INT
        lpString2: *mut i8,  // CHAR*
        cchCount2: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi)]
public static extern int CompareStringA(uint Locale, uint dwCmpFlags, IntPtr lpString1, int cchCount1, IntPtr lpString2, int cchCount2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CompareStringA' -Namespace Win32 -PassThru
# $api::CompareStringA(Locale, dwCmpFlags, lpString1, cchCount1, lpString2, cchCount2)

#uselib "KERNEL32.dll"
#func global CompareStringA "CompareStringA" sptr, sptr, sptr, sptr, sptr, sptr
; CompareStringA Locale, dwCmpFlags, varptr(lpString1), cchCount1, varptr(lpString2), cchCount2   ; 戻り値は stat
; Locale : DWORD -> "sptr"
; dwCmpFlags : DWORD -> "sptr"
; lpString1 : CHAR* -> "sptr"
; cchCount1 : INT -> "sptr"
; lpString2 : CHAR* -> "sptr"
; cchCount2 : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global CompareStringA "CompareStringA" int, int, var, int, var, int
; res = CompareStringA(Locale, dwCmpFlags, lpString1, cchCount1, lpString2, cchCount2)
; Locale : DWORD -> "int"
; dwCmpFlags : DWORD -> "int"
; lpString1 : CHAR* -> "var"
; cchCount1 : INT -> "int"
; lpString2 : CHAR* -> "var"
; cchCount2 : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global CompareStringA "CompareStringA" int, int, sptr, int, sptr, int
; res = CompareStringA(Locale, dwCmpFlags, varptr(lpString1), cchCount1, varptr(lpString2), cchCount2)
; Locale : DWORD -> "int"
; dwCmpFlags : DWORD -> "int"
; lpString1 : CHAR* -> "sptr"
; cchCount1 : INT -> "int"
; lpString2 : CHAR* -> "sptr"
; cchCount2 : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。