strstr、wcsstr、_mbsstr、_mbsstr_l

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

文字列内で最初に出現する検索文字列へのポインターを返します。

char *strstr(
   const char *str,
   const char *strSearch 
); // C only
char *strstr(
   char *str,
   const char *strSearch 
); // C++ only
const char *strstr(
   const char *str,
   const char *strSearch 
); // C++ only
wchar_t *wcsstr(
   const wchar_t *str,
   const wchar_t *strSearch 
); // C only
wchar_t *wcsstr(
   wchar_t *str,
   const wchar_t *strSearch 
); // C++ only
const wchar_t *wcsstr(
   const wchar_t *str,
   const wchar_t *strSearch 
); // C++ only
unsigned char *_mbsstr(
   const unsigned char *str,
   const unsigned char *strSearch 
); // C only
unsigned char *_mbsstr(
   unsigned char *str,
   const unsigned char *strSearch 
); // C++ only
const unsigned char *_mbsstr(
   const unsigned char *str,
   const unsigned char *strSearch 
); // C++ only
unsigned char *_mbsstr_l(
   const unsigned char *str,
   const unsigned char *strSearch,
   _locale_t locale
); // C only
unsigned char *_mbsstr_l(
   unsigned char *str,
   const unsigned char *strSearch,
   _locale_t locale
); // C++ only
const unsigned char *_mbsstr_l(
   const unsigned char *str,
   const unsigned char *strSearch,
   _locale_t locale
); // C++ only

パラメーター

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

戻り値

str 内で strSearch が最初に出現する位置を指すポインターを返します。strSearch が str に見つからない場合は、NULL を返します。 strSearch が長さ 0 の文字列を指す場合は、str を返します。

解説

strstr 関数は、str 内で strSearch が最初に出現する位置を指すポインターを返します。検索には、終端の NULL 文字は含まれません。 wcsstr 関数と _mbsstr 関数は、strstr 関数のワイド文字バージョンとマルチバイト文字バージョンです。 wcsstr 関数の引数と戻り値はワイド文字列で、_mbsstr 関数の引数と戻り値はマルチバイト文字列です。 _mbsstr は、パラメーターを検証します。 str または strSearch が NULL の場合、「パラメーターの検証」に説明されているように、無効なパラメーターハンドラーが呼び出されます。実行の継続が許可された場合、_mbsstr は errno を EINVAL に設定し、0 を返します。 strstr および wcsstr は、パラメーターを検証しません。それ以外では、これらの関数の動作は同じです。

セキュリティに関するメモ
これらの関数は、バッファーオーバーランが原因で発生する可能性のある問題の影響を受けます。バッファーオーバーランは、システムを攻撃するときによく使用される方法であり、その結果、認められていない権限が昇格されます。詳細については、「Avoiding Buffer Overruns」を参照してください。

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 が定義されている場合
_tcsstr	strstr	_mbsstr	wcsstr
適用なし	適用なし	_mbsstr_l	適用なし

必要条件

ルーチン	必須ヘッダー
strstr	<string.h>
wcsstr	<string.h> または <wchar.h>
_mbsstr, _mbsstr_l	<mbstring.h>

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

使用例

// crt_strstr.c

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

char str[] =    "lazy";
char string[] = "The quick brown dog jumps over the lazy fox";
char fmt1[] =   "         1         2         3         4         5";
char fmt2[] =   "12345678901234567890123456789012345678901234567890";

int main( void )
{
   char *pdest;
   int  result;
   printf( "String to be searched:\n   %s\n", string );
   printf( "   %s\n   %s\n\n", fmt1, fmt2 );
   pdest = strstr( string, str );
   result = (int)(pdest - string + 1);
   if ( pdest != NULL )
      printf( "%s found at position %d\n", str, result );
   else
      printf( "%s not found\n", str );
}