strncmp、wcsncmp、_mbsncmp、_mbsncmp_l

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

現在のロケールまたは指定されたロケールを使用し、2 つの文字列の文字を比較します。

int strncmp(
   const char *string1,
   const char *string2,
   size_t count 
);
int wcsncmp(
   const wchar_t *string1,
   const wchar_t *string2,
   size_t count 
);
int _mbsncmp(
   const unsigned char *string1,
   const unsigned char *string2,
   size_t count 
);
int _mbsncmp_l(
   const unsigned char *string1,
   const unsigned char *string2,
   size_t count, 
   _locale_t locale
);
int _mbsnbcmp(
   const unsigned char *string1,
   const unsigned char *string2,
   size_t count 
);

パラメーター

string1, string2
比較する文字列。
count
比較する文字数。
locale
使用するロケール。

戻り値

戻り値は、string1 と string2 の部分文字列の関係を示します。

戻り値	説明
< 0	string1 の部分文字列は string2 の部分文字列より小さい。
0	string1 の部分文字列は string2 の部分文字列と同じ。
> 0	string1 の部分文字列は string2 の部分文字列より大きい。

エラーが発生すると、_mbsncmp 関数は、STRING.H と MBSTRING.H で定義されている _NLSCMPERROR を返します。

解説

strncmp 関数は、string1 と string2 の最初の count バイトまでを辞書的に比較し、部分文字列の関係を示す値を返します。 strncmp は _strnicmp の大文字と小文字を区別するバージョンです。 wcsncmp および _mbsncmp は _wcsnicmp および _mbsnicmp の大文字と小文字を区別するバージョンです。

wcsncmp と _mbsncmp は、strncmp のワイド文字バージョンとマルチバイト文字バージョンです。 wcsncmp 関数の引数と戻り値はワイド文字列で、_mbsncmp 関数の引数と戻り値はマルチバイト文字列です。 _mbsncmp 関数は、マルチバイトコードページに基づいてマルチバイト文字のシーケンスを認識し、エラー発生時には _NLSCMPERROR を返します。

_mbsncmp は、パラメーターを検証します。 string1 または string2 が null ポインターの場合は、「パラメーターの検証」に説明されているように、無効なパラメーターハンドラーが呼び出されます。実行の継続が許可された場合、_mbsncmp は _NLSCMPERROR を返し、errno を EINVAL に設定します。 strncmp および wcsncmp は、パラメーターを検証しません。それ以外では、これらの関数の動作は同じです。

出力値は、ロケールの LC_CTYPE カテゴリの設定で決まります。詳細については、「setlocale」を参照してください。 _l サフィックスが付いていないこの関数のバージョンでは、現在のロケールを使用してロケールに依存する動作を行います。_l サフィックスが付いているバージョンは、渡されたロケールパラメーターを代わりに使用する点を除いて同じです。詳細については、「ロケール」を参照してください。

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tcsnccmp	strncmp	_mbsncmp	wcsncmp
_tcsncmp	strncmp	_mbsnbcmp	wcsncmp
_tccmp	マクロまたはインライン関数に割り当てます。	_mbsncmp	マクロまたはインライン関数に割り当てます。
適用なし	適用なし	_mbsncmp_l	適用なし

必要条件

ルーチン	必須ヘッダー
strncmp	<string.h>
wcsncmp	<string.h> または <wchar.h>
_mbsncmp, _mbsncmp_l	<mbstring.h>

互換性の詳細については、「C ランタイムライブラリ」の「互換性」を参照してください。

使用例

// crt_strncmp.c
#include <string.h>
#include <stdio.h>

char string1[] = "The quick brown dog jumps over the lazy fox";
char string2[] = "The QUICK brown fox jumps over the lazy dog";

int main( void )
{
   char tmp[20];
   int result;
   printf( "Compare strings:\n      %s\n      %s\n\n",
           string1, string2 );
   printf( "Function:   strncmp (first 10 characters only)\n" );
   result = strncmp( string1, string2 , 10 );
   if( result > 0 )
      strcpy_s( tmp, sizeof(tmp), "greater than" );
   else if( result < 0 )
      strcpy_s( tmp, sizeof(tmp), "less than" );
   else
      strcpy_s( tmp, sizeof(tmp), "equal to" );
   printf( "Result:      String 1 is %s string 2\n\n", tmp );
   printf( "Function:   strnicmp _strnicmp (first 10 characters only)\n" );
   result = _strnicmp( string1, string2, 10 );
   if( result > 0 )
      strcpy_s( tmp, sizeof(tmp), "greater than" );
   else if( result < 0 )
      strcpy_s( tmp, sizeof(tmp), "less than" );
   else
      strcpy_s( tmp, sizeof(tmp), "equal to" );
   printf( "Result:      String 1 is %s string 2\n", tmp );
}