_mbsnbcmp、_mbsnbcmp_l

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

2 つのマルチバイト文字列の最初の n バイトを比較します。

int _mbsnbcmp(
   const unsigned char *string1,
   const unsigned char *string2,
   size_t count 
);
int _mbsnbcmp_l(
   const unsigned char *string1,
   const unsigned char *string2,
   size_t count,
   _locale_t locale
);

パラメータ

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

戻り値

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

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

エラーが発生すると、_mbsnbcmp 関数は、String.h と Mbstring.h で定義されている _NLSCMPERROR を返します。

解説

_mbsnbcmp 関数は、string1 と string2 の最初の count バイトまでを辞書的に比較し、部分文字列の関係を示す値を返します。_mbsnbcmp は、_mbsnbicmp の大文字と小文字を区別するバージョンです。strcoll とは異なり、_mbsnbcmp はロケールの影響を受けません。_mbsnbcmp は、現在使用しているマルチバイトコードページに基づいて、マルチバイト文字シーケンスを認識します。

_mbsncmp 関数は、バイト単位でなく文字単位で文字列を比較します。この点以外では、_mbsnbcmp 関数の動作は _mbsncmp 関数と同じです。

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

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

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

Tchar.h のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tcsncmp	strncmp	_mbsnbcmp	wcsncmp
_tcsncmp_l	strncmp	_mbsnbcml	wcsncmp

必要条件

ルーチン	必須ヘッダー
_mbsnbcmp	<mbstring.h>
_mbsnbcmp_l	<mbstring.h>

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

使用例

// crt_mbsnbcmp.c
#include <mbstring.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", string1 );
   printf( "          %s\n\n", string2 );
   printf( "Function: _mbsnbcmp (first 10 characters only)\n" );
   result = _mbsncmp( string1, string2 , 10 );
   if( result > 0 )
      _mbscpy_s( tmp, sizeof(tmp), "greater than" );
   else if( result < 0 )
      _mbscpy_s( tmp, sizeof(tmp), "less than" );
   else
      _mbscpy_s( tmp, sizeof(tmp), "equal to" );
   printf( "Result:   String 1 is %s string 2\n\n", tmp );
   printf( "Function: _mbsnicmp _mbsnicmp (first 10 characters only)\n" );
   result = _mbsnicmp( string1, string2, 10 );
   if( result > 0 )
      _mbscpy_s( tmp, sizeof(tmp), "greater than" );
   else if( result < 0 )
      _mbscpy_s( tmp, sizeof(tmp), "less than" );
   else
      _mbscpy_s( tmp, sizeof(tmp), "equal to" );
   printf( "Result:   String 1 is %s string 2\n\n", tmp );
}

出力

Compare strings:
          The quick brown dog jumps over the lazy fox
          The QUICK brown fox jumps over the lazy dog

Function: _mbsnbcmp (first 10 characters only)
Result:   String 1 is greater than string 2

Function: _mbsnicmp _mbsnicmp (first 10 characters only)
Result:   String 1 is equal to string 2