strpbrk、wcspbrk、_mbspbrk、_mbspbrk_l

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

文字列をスキャンして、指定された文字セット内で文字を見つけます。

char *strpbrk(
   const char *str,
   const char *strCharSet 
); // C only
char *strpbrk(
   char *str,
   const char *strCharSet 
); // C++ only
const char *strpbrk(
   const char *str,
   const char *strCharSet 
); // C++ only
wchar_t *wcspbrk(
   const wchar_t *str,
   const wchar_t *strCharSet 
); // C only
wchar_t *wcspbrk(
   wchar_t *str,
   const wchar_t *strCharSet 
); // C++ only
const wchar_t *wcspbrk(
   const wchar_t *str,
   const wchar_t *strCharSet 
); // C++ only
unsigned char *_mbspbrk(
   const unsigned char *str,
   const unsigned char *strCharSet 
); // C only
unsigned char *_mbspbrk(
   unsigned char *str,
   const unsigned char *strCharSet 
); // C++ only
const unsigned char *_mbspbrk(
   const unsigned char *str,
   const unsigned char *strCharSet 
); // C++ only
unsigned char *_mbspbrk_l(
   const unsigned char *str,
   const unsigned char *strCharSet,
   _locale_t locale
); // C only
unsigned char *_mbspbrk_l(
   unsigned char *str,
   const unsigned char *strCharSet,
   _locale_t locale
); // C++ only
const unsigned char *_mbspbrk_l(
   const unsigned char *str,
   const unsigned char* strCharSet,
   _locale_t locale
); // C++ only

パラメーター

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

戻り値

strCharSet に属する文字が str 内で最初に出現した位置を指すポインターを返します。2 つの引数の文字列に共通する文字がない場合は、NULL ポインターを返します。

解説

strpbrk 関数は、strCharSet の文字セットに属する文字が str 内で最初に出現する位置を指すポインターを返します。検索には、終端の NULL 文字は含まれません。

wcspbrk と _mbspbrk は、strpbrk のワイド文字バージョンとマルチバイト文字バージョンです。 wcspbrk 関数の引数と戻り値はワイド文字列で、_mbspbrk 関数の引数と戻り値はマルチバイト文字列です。

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

_mbspbrk 関数は _mbscspn 関数と似ていますが、_mbspbrk 関数では size_t 型の値ではなくポインターを返す点で異なります。

C では、これらの関数は、最初の引数に const ポインターを受け取ります。 C++ では、2 つのオーバーロードを使用できます。 const へのポインターを受け取るオーバーロードでは、const へのポインターが返されます。非 const へのポインターを受け取るバージョンでは、非 const へのポインターが返されます。この関数の const と非 const の両方のバージョンが使用できる場合、_CONST_CORRECT_OVERLOADS というマクロが定義されます。 C++ のいずれのオーバーロードでも、非 const の動作が求められる場合は、シンボル _CONST_RETURN を定義してください。

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

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tcspbrk	strpbrk	_mbspbrk	wcspbrk
適用なし	適用なし	_mbspbrk_l	適用なし

必要条件

ルーチン	必須ヘッダー
strpbrk	<string.h>
wcspbrk	<string.h> または <wchar.h>
_mbspbrk, _mbspbrk_l	<mbstring.h>

互換性の詳細については、「互換性」を参照してください。

使用例

// crt_strpbrk.c

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

int main( void )
{
   char string[100] = "The 3 men and 2 boys ate 5 pigs\n";
   char *result = NULL;

   // Return pointer to first digit in "string".
   printf( "1: %s\n", string );
   result = strpbrk( string, "0123456789" );
   printf( "2: %s\n", result++ );
   result = strpbrk( result, "0123456789" );
   printf( "3: %s\n", result++ );
   result = strpbrk( result, "0123456789" );
   printf( "4: %s\n", result );
}