_stricoll、_wcsicoll、_mbsicoll、_stricoll_l、_wcsicoll_l、_mbsicoll_l

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

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

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

解説

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

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

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

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