strcoll、wcscoll、_mbscoll、_strcoll_l、_wcscoll_l、_mbscoll_l
現在のロケールまたは指定された LC_COLLATE 変換状態カテゴリを使用して、文字列を比較します。
重要
_mbscoll および _mbscoll_l は、Windows ランタイムで実行するアプリケーションでは使用できません。詳細については、「/ZW でサポートされない 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 は EINVAL に errno を設定することがあります。 wcscoll の呼び出し時にエラーを確認するには、errno を 0 に設定し、wcscoll を呼び出した後 errno をチェックします。
解説
これらの各関数は、現在使用中のコード ページに基づき、大文字小文字を区別して string1 および string2 を比較します。 これらの関数は、現在のコード ページの文字セット順序と辞書式文字順序との間に相違点があり、この違いが文字列比較に関係がある場合にのみ使用します。
これらのすべての関数では、パラメーターの検証が行われます。 string1 または string2 が null ポインターの場合、または count が INT_MAX 以上の場合、「パラメーターの検証」に説明されているように、無効なパラメーター ハンドラーが呼び出されます。 実行の継続が許可された場合、これらの関数は _NLSCMPERROR を返し、errno を EINVAL に設定します。
各ロケールには文字を並べ替えるための異なる規則があるため、2 つの文字列の比較は、ロケールに依存する操作となります。 _l サフィックスが付いていないこれらの関数のバージョンでは、このロケールに依存する動作に現在のスレッドのロケールを使用します。_l サフィックスが付いているバージョンは、現在のロケールの代わりに渡されたロケールをパラメーターとして使用する点を除いて、対応するサフィックスなしの関数と同じです。 詳細については、「ロケール」を参照してください。
汎用テキスト ルーチンのマップ
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> |
互換性の詳細については、「互換性」を参照してください。
同等の .NET Framework 関数
参照
関連項目
_mbsnbcoll、_mbsnbcoll_l、_mbsnbicoll、_mbsnbicoll_l
_stricmp、_wcsicmp、_mbsicmp、_stricmp_l、_wcsicmp_l、_mbsicmp_l
strncmp、wcsncmp、_mbsncmp、_mbsncmp_l
_strnicmp、_wcsnicmp、_mbsnicmp、_strnicmp_l、_wcsnicmp_l、_mbsnicmp_l