strcspn、wcscspn、_mbscspn、_mbscspn_l

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

文字セットに属する文字が文字列内に最初に出現する位置のインデックスを返します。

size_t strcspn(
   const char *str,
   const char *strCharSet 
);
size_t wcscspn(
   const wchar_t *str,
   const wchar_t *strCharSet 
);
size_t _mbscspn(
   const unsigned char *str,
   const unsigned char *strCharSet 
);
size_t _mbscspn(
   const unsigned char *str,
   const unsigned char *strCharSet,
   _locale_t locale
);

パラメーター

str
NULL で終わる検索文字列。
strCharSet
NULL で終わる文字セット。
locale
使用するロケール。

戻り値

これらの関数は、strCharSet に属する文字が str に最初に出現する位置のインデックスを返します。 strCharSet に属する文字が str にない場合、戻り値は str の長さになります。

エラーを示す戻り値は予約されていません。

解説

wcscspn と _mbscspn は、strcspn のワイド文字バージョンとマルチバイト文字バージョンです。 wcscspn 関数の引数はワイド文字列で、_mbscspn 関数の引数はマルチバイト文字列です。

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

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

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tcscspn	strcspn	_mbscspn	wcscspn
n/a	n/a	_mbscspn_l	n/a

必要条件

ルーチン	必須ヘッダー
strcspn	<string.h>
wcscspn	<string.h> または <wchar.h>
_mbscspn, _mbscspn_l	<mbstring.h>

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

使用例

// crt_strcspn.c

#include <string.h>
#include <stdio.h>

void test( const char * str, const char * strCharSet )
{
   int pos = strcspn( str, strCharSet );
   printf( "strcspn( \"%s\", \"%s\" ) = %d\n", str, strCharSet, pos );    
}

int main( void )
{
   test( "xyzbxz", "abc" );
   test( "xyzbxz", "xyz" );
   test( "xyzbxz", "no match" );
   test( "xyzbxz", "" );
   test( "", "abc" );
   test( "", "" );
}