_strnset_s、 _strnset_s_l、 _wcsnset_s、 _wcsnset_s_l、 _mbsnset_s、 _mbsnset_s_l、 _tcsnset_s、 _tcsncset_s、 _tcsncset_s_l

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

重要

_mbsnset_s および _mbsnset_s_l は、Windows ランタイムで実行するアプリケーションでは使用できません。 詳細については、「ユニバーサル Windows プラットフォーム アプリでサポートされていない CRT 関数」を参照してください。

_tcsnset_s、_tcsnset_s_l、_tcsncset_s、および_tcsncset_s_lについては、Generic-text 関数のマッピングを参照してください。

構文

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 で終わる文字列ではない場合、または size 引数が 0 以下の場合は、「パラメーター検証で説明されているように、無効なパラメーター ハンドラーが呼び出されます。 実行の続行が許可された場合、これらの関数はエラー コードを返し、errno をそのエラー コードに設定します。 より具体的な値が適用されない場合、既定のエラー コードは EINVAL されます。

解説

これらの関数は、count の最初の str 文字数までを c に設定します。 count が str のサイズを超えると、その str のサイズが count の代わりに使用されます。 count の値が numberOfElements を超え、この両方のパラメーターが str のサイズを超えると、エラーが発生します。

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

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

これらの関数のデバッグ ライブラリ バージョンでは、最初にバッファーに 0xFEが格納されます。 この動作を無効にするには、_CrtSetDebugFillThreshold を使用します。

既定では、この関数のグローバル状態の適用対象は、アプリケーションになります。 この動作を変更するには、「CRT でのグローバル状態」を参照してください。

汎用テキスト関数マッピング

tchar.h列の関数は、コンパイル時に定義されている文字セットに応じて、他の列の関数にマップされます。

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
_tcsncset_s	_strnset_s	_mbsnset_s	_wcsnset_s
_tcsncset_s_l	_strnset_s_l	_mbsnset_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>

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

例

// 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

関連項目

文字列操作
ロケール
マルチバイト文字のシーケンスの解釈
strcat、 wcscat、 _mbscat
strcmp、 wcscmp、 _mbscmp
strcpy、 wcscpy、 _mbscpy
_strset、 _strset_l、 _wcsset、 _wcsset_l、 _mbsset、 _mbsset_l