strcoll、wcscoll、_mbscoll、_strcoll_l、_wcscoll_l、_mbscoll_l

[アーティクル]
08/09/2011

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

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 をインクルードします。 string1 または string2 が NULL か、または照合順序のドメイン外のワイド文字コードが含まれていると、wcscoll が失敗することがあります。 wcscoll 関数は、エラーが発生した場合、グローバル変数 errno に EINVAL を設定することがあります。 wcscoll 関数の呼び出しエラーを調べるには、errno を 0 に設定し、wcscoll 関数を呼び出してから errno の値を確認します。

解説

各関数は、現在使用中のコードページに基づいて、大文字と小文字を区別して string1 と string2 を比較します。現在のコードページで文字セットの文字順と辞書式の文字順が異なり、その違いが文字列を比較するときに問題になる場合にだけ、これらの関数を使用してださい。

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

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

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