_stricoll、 _wcsicoll、 _mbsicoll、 _stricoll_l、 _wcsicoll_l、 _mbsicoll_l

ロケール固有の情報を使用して文字列を比較します。

重要

_mbsicoll および _mbsicoll_l は、Windows ランタイムで実行するアプリケーションでは使用できません。 詳細については、「ユニバーサル Windows プラットフォーム アプリでサポートされていない CRT 関数」を参照してください。

構文

int _stricoll(
   const char *string1,
   const char *string2
);
int _wcsicoll(
   const wchar_t *string1,
   const wchar_t *string2
);
int _mbsicoll(
   const unsigned char *string1,
   const unsigned char *string2
);
int _stricoll_l(
   const char *string1,
   const char *string2,
   _locale_t locale
);
int _wcsicoll_l(
   const wchar_t *string1,
   const wchar_t *string2,
   _locale_t locale
);
int _mbsicoll_l(
   const unsigned char *string1,
   const unsigned char *string2,
   _locale_t locale
);

パラメーター

string1, string2
Null で終わる比較対象の文字列。

locale
使用するロケール。

戻り値

これらの各関数は、次のように、 string1 と string2の関係を示す値を返します。

戻り値	string1 の string2 との関係
< 0	string1 が string2 より小さい
0	string1 が string2 と同じ
> 0	string1 が string2 より大きい
_NLSCMPERROR	エラーが発生しました。

これらの各関数は、_NLSCMPERROR を返します。 _NLSCMPERRORを使用するには、<string.h> または <mbstring.h> を含めます。 _wcsicoll は、string1 か string2 に照合シーケンスのドメイン外のワイド文字コードが含まれている場合に失敗します。 エラーが発生した場合、_wcsicoll は errno に EINVAL を設定することがあります。 _wcsicoll の呼び出し時にエラーを確認するには、errno を 0 に設定し、errno を呼び出した後 _wcsicoll をチェックします。

解説

これらの各関数は、現在使用中のコード ページに基づき、大文字小文字を区別せずに string1 および string2 を比較します。 これらの関数は、現在のコード ページで文字セットの順序と辞書文字の順序に違いがあり、この違いが文字列比較に重要な場合にのみ使用する必要があります。

_stricmp と _stricoll では、_stricmp による比較は LC_CTYPE の影響を受けるのに対し、_stricoll による比較は、ロケールの LC_CTYPE カテゴリと LC_COLLATE カテゴリに基づくという点が異なります。 LC_COLLATEカテゴリの詳細については、「setlocaleカテゴリと Locale カテゴリを参照してください。 _l サフィックスが付いていないこれらの関数のバージョンは、現在のロケールを使用します。_l サフィックスが付いているバージョンは、代わりに渡されたロケールを使用する点を除いて同じです。 詳細については、「 Locale」を参照してください。

これらのすべての関数では、パラメーターの検証が行われます。 string1またはstring2がポインターNULL場合、「パラメーターの検証説明されているように、無効なパラメーター ハンドラーが呼び出されます。 実行の継続が許可された場合、これらの関数は _NLSCMPERROR を返し、errno を EINVAL に設定します。

既定では、この関数のグローバル状態の適用対象は、アプリケーションになります。 この動作を変更するには、「CRT でのグローバル状態」を参照してください。

汎用テキスト ルーチンのマップ

TCHAR.H のルーチン	_UNICODE と _MBCS が定義されていない	_MBCS が定義されている	_UNICODE が定義されている
_tcsicoll	_stricoll	_mbsicoll	_wcsicoll

要件

ルーチンによって返される値	必須ヘッダー
_stricoll, _stricoll_l	<string.h>
_wcsicoll, _wcsicoll_l	<wchar.h>、<string.h>
_mbsicoll, _mbsicoll_l	<mbstring.h>

互換性の詳細については、「 Compatibility」を参照してください。

関連項目

ロケール
文字列操作
strcoll 関数
localeconv
_mbsnbcoll、 _mbsnbcoll_l、 _mbsnbicoll、 _mbsnbicoll_l
setlocale, _wsetlocale
strcmp、 wcscmp、 _mbscmp
_stricmp、 _wcsicmp、 _mbsicmp、 _stricmp_l、 _wcsicmp_l、 _mbsicmp_l
strncmp、 wcsncmp、 _mbsncmp、 _mbsncmp_l
_strnicmp、 _wcsnicmp、 _mbsnicmp、 _strnicmp_l、 _wcsnicmp_l、 _mbsnicmp_l
strxfrm、 wcsxfrm、 _strxfrm_l、 _wcsxfrm_l