_strset_s、_wcsset_s、_wcsset_s_l、_mbsset_s、_mbsset_s_l

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

文字列の複数の文字を 1 つの文字に設定します。これらの関数は、「CRT のセキュリティ機能」に説明されているように、_strset、_strset_l、_wcsset、_wcsset_l、_mbsset、_mbsset_l のセキュリティが強化されたバージョンです。

errno_t _strset_s(
   char *str,
   size_t numberOfElements,
   int c 
);
errno_t _strset_s_l(
   char *str,
   size_t numberOfElements,
   int c,
   locale_t locale
);
errno_t _wcsset_s(
   wchar_t *str,
   size_t numberOfElements,
   wchar_t c 
);
errno_t *_wcsset_s_l(
   wchar_t *str,
   size_t numberOfElements,
   wchar_t c,
   locale_t locale
);
errno_t _mbsset_s(
   unsigned char *str,
   size_t numberOfElements,
   unsigned int c 
);
errno_t _mbsset_s_l(
   unsigned char *str,
   size_t numberOfElements,
   unsigned int c,
   _locale_t locale
);

パラメーター

str
NULL で終わる設定対象の文字列。
numberOfElements
str バッファーのサイズ。
c
文字設定。
locale
使用するロケール。

戻り値

正常に終了した場合は 0 を返し、それ以外の場合はエラーコードを返します。

これらの関数は、引数を検証します。 str が null ポインターの場合、numberOfElements 引数が 0 以下の場合、または、引数に指定されたブロックが null で終わらない場合、「パラメーターの検証」に説明されているように、無効なパラメーターハンドラーが呼び出されます。実行の継続が許可された場合、これらの関数は EINVAL を返し、errno を EINVAL に設定します。

解説

_strset_s 関数は、終端の null 文字を除き、str のすべての文字を c に設定します (char に変換)。 _wcsset_s 関数と _mbsset_s 関数は、_strset_s 関数のワイド文字バージョンとマルチバイト文字バージョンです。引数と戻り値のデータ型は、それぞれのバージョンで異なります。それ以外では、これらの関数の動作は同じです。

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

これらの関数のデバッグバージョンは、最初にバッファーを 0xFD で埋めます。この動作を無効にするには、_CrtSetDebugFillThreshold を使用します。

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tcsset_s	_strset_s	_mbsset_s	_wcsset_s
_tcsset_s_l	_strset_s_l	_mbsset_s_l	_wcsset_s_l

必要条件

ルーチン	必須ヘッダー
_strset_s	<string.h>
_strset_s_l	<tchar.h>
_wcsset_s	<string.h> または <wchar.h>
_wcsset_s_l	<tchar.h>
_mbsset_s, _mbsset_s_l	<mbstring.h>

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

使用例

// crt_strset_s.c
#include <string.h>
#include <stdio.h>
#include <stdlib.h>

int main( void )
{
   char string[] = "Fill the string with something.";
   printf( "Before: %s\n", string );
   _strset_s( string, _countof(string), '*' );
   printf( "After:  %s\n", string );
}