CompareString 関数 (winnls.h)
識別子で指定された ロケール について、2 つの文字列を比較します。
構文
int CompareString(
[in] LCID Locale,
[in] DWORD dwCmpFlags,
[in] LPCTSTR lpString1,
[in] int cchCount1,
[in] LPCTSTR lpString2,
[in] int cchCount2
);
パラメーター
[in] Locale
比較に使用されるロケールのロケール識別子。 MAKELCID マクロを使用してロケール識別子を作成するか、次のいずれかの定義済み値を使用できます。
- LOCALE_CUSTOM_DEFAULT
- LOCALE_CUSTOM_UI_DEFAULT
- LOCALE_CUSTOM_UNSPECIFIED
- LOCALE_INVARIANT
- LOCALE_SYSTEM_DEFAULT
- LOCALE_USER_DEFAULT
[in] dwCmpFlags
関数が 2 つの文字列を比較する方法を示すフラグ。 詳細な定義については、CompareStringEx の dwCmpFlags パラメーターを参照してください。
[in] lpString1
比較する最初の文字列へのポインター。
[in] cchCount1
終端の null 文字を除く、 lpString1 で示される文字列の長さ。 この値は、関数の ANSI バージョンのバイトと Unicode バージョンのワイド文字を表します。 文字列が null で終わる場合、アプリケーションは負の値を指定できます。 この場合、関数は長さを自動的に決定します。
[in] lpString2
比較する 2 番目の文字列へのポインター。
[in] cchCount2
終端の null 文字を除く、 lpString2 で示される文字列の長さ。 この値は、関数の ANSI バージョンのバイトと Unicode バージョンのワイド文字を表します。 文字列が null で終わる場合、アプリケーションは負の値を指定できます。 この場合、関数は長さを自動的に決定します。
戻り値
CompareStringEx に記述されている値を返します。
注釈
「CompareStringEx の解説」を参照してください。
アプリケーションが ANSI バージョンの CompareString を呼び出している場合、関数は指定されたロケールの既定のコード ページを介してパラメーターを変換します。 したがって、アプリケーションで UTF-8 テキストを処理するために CompareString を使用することはできません。
通常、大文字と小文字を区別しない比較では、ロケールがトルコ語またはアゼルバイジャン語であっても、 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) は小文字の小文字の形式で、上記のドット付きラテン大文字 I (U+0130) です。
Windows 8 以降: 関数の ANSI バージョンは Winnls.h で宣言され、Unicode バージョンは Stringapiset.h で宣言されています。 Windows 8より前は、両方のバージョンが Winnls.h で宣言されていました。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winnls.h (Windows.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |