strspn、wcsspn、_mbsspn、_mbsspn_l

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

更新 : 2007 年 11 月

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

size_t strspn(
   const char *str,
   const char *strCharSet 
);
size_t wcsspn(
   const wchar_t *str,
   const wchar_t *strCharSet 
);
size_t _mbsspn(
   const unsigned char *str,
   const unsigned char *strCharSet 
);
size_t _mbsspn_l(
   const unsigned char *str,
   const unsigned char *strCharSet,
   _locale_t locale
);

パラメータ

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

戻り値

strCharSet に含まれる文字のみで構成される str 内の部分文字列の長さを示す整数値を返します。str が strCharSet にない文字で始まる場合、この関数は 0 を返します。

解説

strspn 関数は、strCharSet の文字セットに属さない文字が str で最初に出現する位置のインデックスを返します。検索には、終端の NULL 文字は含まれません。

wcsspn 関数と _mbsspn 関数は、strspn 関数のワイド文字バージョンとマルチバイト文字バージョンです。wcsspn 関数の引数はワイド文字列で、_mbsspn 関数の引数はマルチバイト文字列です。_mbsspn はパラメータを検証します。str または strCharSet が NULL の場合は、「パラメータの検証」に説明されているように、無効なパラメータハンドラが呼び出されます。実行の継続が許可された場合、_mbspn 関数は errno を EINVAL に設定し、0 を返します。strspn 関数と wcsspn 関数はそれぞれのパラメータを検証しません。それ以外では、これらの関数の動作は同じです。

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

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tcsspn	strspn	_mbsspn	wcsspn
適用なし	適用なし	_mbsspn_l	適用なし

必要条件

ルーチン	必須ヘッダー
strspn	<string.h>
wcsspn	<string.h> または <wchar.h>
_mbsspn, _mbsspn_l	<mbstring.h>

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

使用例

// crt_strspn.c
// This program uses strspn to determine
// the length of the segment in the string "cabbage"
// consisting of a's, b's, and c's. In other words,
// it finds the first non-abc letter.
//

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

int main( void )
{
   char string[] = "cabbage";
   int  result;
   result = strspn( string, "abc" );
   printf( "The portion of '%s' containing only a, b, or c "
           "is %d bytes long\n", string, result );
}

The portion of 'cabbage' containing only a, b, or c is 5 bytes long