strcoll、 wcscoll、 _mbscoll、 _strcoll_l、 _wcscoll_l、 _mbscoll_l

現在のロケールまたは指定された LC_COLLATE 変換状態カテゴリを使用して文字列を比較します。

重要

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

構文

int strcoll(
   const char *string1,
   const char *string2
);
int wcscoll(
   const wchar_t *string1,
   const wchar_t *string2
);
int _mbscoll(
   const unsigned char *string1,
   const unsigned char *string2
);
int _strcoll_l(
   const char *string1,
   const char *string2,
   _locale_t locale
);
int wcscoll_l(
   const wchar_t *string1,
   const wchar_t *string2,
   _locale_t locale
);
int _mbscoll_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 を使用するには、STRING.H または MBSTRING.H をインクルードします。 wcscoll は、 string1 または string2 が NULL されているか、照合シーケンスのドメイン外のワイド文字コードを含む場合に失敗する可能性があります。 エラーが発生した場合、wcscoll は errno に EINVAL を設定することがあります。 wcscoll の呼び出し時にエラーを確認するには、errno を 0 に設定し、errno を呼び出した後 wcscoll をチェックします。

解説

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

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

各ロケールには文字を並べ替えるための異なる規則があるため、2 つの文字列の比較は、ロケールに依存する操作となります。 _l サフィックスが付いていないこれらの関数のバージョンでは、このロケールに依存する動作に現在のスレッドのロケールを使用します。_l サフィックスが付いているバージョンは、現在のロケールの代わりに渡されたロケールをパラメーターとして使用する点を除いて、対応するサフィックスなしの関数と同じです。 詳細については、「 Locale」を参照してください。

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

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

TCHAR.H のルーチン	_UNICODE と _MBCS が定義されていない	_MBCS が定義されている	_UNICODE が定義されている
_tcscoll	strcoll	_mbscoll	wcscoll

要件

ルーチンによって返される値	必須ヘッダー
strcoll	<string.h>
wcscoll	<wchar.h>、<string.h>
_mbscoll, _mbscoll_l	<mbstring.h>
_strcoll_l	<string.h>
_wcscoll_l	<wchar.h>、<string.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