_strnset_s、_strnset_s_l、_wcsnset_s、_wcsnset_s_l、_mbsnset_s、_mbsnset_s_l

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

更新 : 2007 年 11 月

文字列の文字を所定の書式に初期化します。これらの関数は、「CRT のセキュリティ強化」に説明されているように、_strnset、_strnset_l、_wcsnset、_wcsnset_l、_mbsnset、_mbsnset_l のセキュリティが強化されたバージョンです。

errno_t _strnset_s(
   char *str,
   size_t numberOfElements,
   int c,
   size_t count 
);
errno_t _strnset_s_l(
   char *str,
   size_t numberOfElements,
   int c,
   size_t count,
   locale_t locale
);
errno_t _wcsnset_s(
   wchar_t *str,
   size_t numberOfElements,
   wchar_t c,
   size_t count 
);
errno_t _wcsnset_s_l(
   wchar_t *str,
   size_t numberOfElements,
   wchar_t c,
   size_t count,
   _locale_t locale
);
errno_t _mbsnset_s(
   unsigned char *str,
   size_t numberOfElements,
   unsigned int c,
   size_t count 
);
errno_t _mbsnset_s_l(
   unsigned char *str,
   size_t numberOfElements,
   unsigned int c,
   size_t count,
   _locale_t locale
);

パラメータ

str
変更対象の文字列。
numberOfElements
str バッファのサイズ。
c
文字設定。
count
設定する文字数。
locale
使用するロケール。

戻り値

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

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

解説

これらの関数は、str の最初の count 文字数までを c に設定します。count が str のサイズ (つまり、numberOfElements) を超えると、count の代わりに、そのサイズが使用されます。

_wcsnset_s 関数と _mbsnset_s 関数は、_strnset_s 関数のワイド文字バージョンとマルチバイト文字バージョンです。_wcsnset_s 関数の文字列引数はワイド文字列で、_mbsnset_s 関数の文字列引数はマルチバイト文字列です。それ以外では、これらの関数の動作は同じです。

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

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

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tcsnset_s	_strnset_s	_mbsnbset_s	_wcsnset_s
_tcsnset_s_l	_strnset_s_l	_mbsnbset_s_l	_wcsnset_s_l

必要条件

ルーチン	必須ヘッダー
_strnset_s	<string.h>
_strnset_s_l	<tchar.h>
_wcsnset_s	<string.h> または <wchar.h>
_wcsnset_s_l	<tchar.h>
_mbsnset_s, _mbsnset_s_l	<mbstring.h>

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

使用例

// crt_strnset_s.c
#include <string.h>
#include <stdio.h>

int main( void )
{
   char string[15] = "This is a test";
   /* Set not more than 4 characters of string to be *'s */
   printf( "Before: %s\n", string );
   _strnset_s( string, sizeof(string), '*', 4 );
   printf( "After:  %s\n", string );
}

Before: This is a test
After:  **** is a test