_strncoll、_wcsncoll、_mbsncoll、_strncoll_l、_wcsncoll_l、_mbsncoll_l

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

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

int _strncoll(
   const char *string1,
   const char *string2,
   size_t count 
);
int _wcsncoll(
   const wchar_t *string1,
   const wchar_t *string2,
   size_t count 
);
int _mbsncoll(
   const unsigned char *string1,
   const unsigned char *string2,
   size_t count 
);
int _strncoll_l(
   const char *string1,
   const char *string2,
   size_t count,
   _locale_t locale
);
int _wcsncoll_l(
   const wchar_t *string1,
   const wchar_t *string2,
   size_t count,
   _locale_t locale
);
int _mbsncoll_l(
   const unsigned char *string1,
   const unsigned char *string2,
   size_t count,
   _locale_t locale
);

パラメーター

string1, string2
NULL で終わる比較対象の文字列。
count
比較する文字数。
locale
使用するロケール。

戻り値

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

戻り値	string1 と string2 の関係
< 0	string1 は string2 より小さい。
0	string1 と string2 は等しい。
> 0	string1 は string2 より大きい。

これらの各関数は _NLSCMPERROR を返します。 _NLSCMPERROR を使用するには、STRING.H または MBSTRING.H をインクルードします。 string1 または string2 に照合順序のドメイン外のワイド文字コードが含まれていると、_wcsncoll が失敗することがあります。 _wcsncoll 関数は、エラーが発生した場合、グローバル変数 errno に EINVAL を設定することがあります。 _wcsncoll 関数の呼び出しエラーを調べるには、errno を 0 に設定し、_wcsncoll 関数を呼び出してから errno の値を確認します。

解説

各関数は、使用中のコードページに基づいて、大文字と小文字を区別して string1 と string2 の最初の count 文字を比較します。これらの関数は、コードページで文字セットの文字順と辞書式の文字順が異なり、その違いが文字列を比較するときに問題になる場合のみ使用してださい。文字セットの順序はロケールに依存します。 _lサフィックスが付いていないこの関数のバージョンは現在のロケールを使用し、_lサフィックスが付いているバージョンは、渡されたロケールを代わりに使用する点を除いて同じです。詳細については、「ロケール」を参照してください。

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

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