_mbclen、mblen、_mblen_l

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

更新 : 2007 年 11 月

マルチバイト文字の長さを取得し、有効性をチェックします。

size_t _mbclen(
   const unsigned char *c 
);
int mblen(
   const char *mbstr,
   size_t count 
);
int _mblen_l(
   const char *mbstr,
   size_t count,
   _locale_t locale
);

パラメータ

c
マルチバイト文字。
mbstr
マルチバイト文字のバイトシーケンスのアドレス。
count
確認するバイト数。
locale
使用するロケール。

戻り値

_mbclen 関数は、マルチバイト文字 c の長さ (1 バイトまたは 2 バイト) に応じて 1 または 2 を返します。_mbclen 関数はエラーを返しません。mbstr が NULL ではない場合、mblen マルチバイト文字の長さ (バイト) を返します。mbstr が NULL か、ワイド文字の null 文字を指す場合、mblen は 0 を返します。mbstr が指すオブジェクトが、最初の count 文字内で有効なマルチバイト文字ではない場合、mblen は -1 を返します。

解説

_mbclen は、マルチバイト文字 c の長さ (バイト) を返します。_ismbblead への暗黙の呼び出しによって、c がマルチバイト文字の先行バイトを指していないと判断された場合、_mbclen の結果は予測できません。

mblen は、有効なマルチバイト文字の場合、mbstr の長さをバイト単位で返し、コードページに関連付けられたマルチバイト文字の有効性を判断します。mblen は、mbstr に含まれる count 以下のバイトをチェックしますが、MB_CUR_MAX を超えるバイトはチェックしません。

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

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

Tchar.h のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tclen	マクロまたはインライン関数に割り当てます。	_mbclen	マクロまたはインライン関数に割り当てます。

必要条件

ルーチン	必須ヘッダー
_mbclen	<mbstring.h>
mblen	<stdlib.h>
_mblen_l	<stdlib.h>

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

使用例

// crt_mblen.c
/* illustrates the behavior of the mblen function
 */

#include <stdlib.h>
#include <stdio.h>

int main( void )
{
    int      i;
    char    *pmbc = (char *)malloc( sizeof( char ) );
    wchar_t  wc   = L'a';

    printf( "Convert wide character to multibyte character:\n" );
    wctomb_s( &i, pmbc, sizeof(char), wc );
    printf( "  Characters converted: %u\n", i );
    printf( "  Multibyte character: %x\n\n", *pmbc );

    i = mblen( pmbc, MB_CUR_MAX );
    printf( "Length in bytes of multibyte character %x: %u\n", *pmbc, i );

    pmbc = NULL;
    i = mblen( pmbc, MB_CUR_MAX );
    printf( "Length in bytes of NULL multibyte character %x: %u\n", pmbc, i );
}

出力

Convert wide character to multibyte character:
  Characters converted: 1
  Multibyte character: 61

Length in bytes of multibyte character 61: 1
Length in bytes of NULL multibyte character 0: 0