_strnset、_strnset_l、_wcsnset、_wcsnset_l、_mbsnset、_mbsnset_l

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

文字列の文字を所定の文字に初期化します。これらの関数にはセキュリティが強化されたバージョンがあります。「_strnset_s、_strnset_s_l、_wcsnset_s、_wcsnset_s_l、_mbsnset_s、_mbsnset_s_l」を参照してください。

char *_strnset(
   char *str,
   int c,
   size_t count 
);
char *_strnset_l(
   char *str,
   int c,
   size_t count,
   locale_t locale
);
wchar_t *_wcsnset(
   wchar_t *str,
   wchar_t c,
   size_t count 
);
wchar_t *_wcsnset_l(
   wchar_t *str,
   wchar_t c,
   size_t count,
   _locale_t locale
);
unsigned char *_mbsnset(
   unsigned char *str,
   unsigned int c,
   size_t count 
);
unsigned char *_mbsnset_l(
   unsigned char *str,
   unsigned int c,
   size_t count,
   _locale_t locale
);

パラメーター

str
変更対象の文字列。
c
文字設定。
count
設定する文字数。
locale
使用するロケール。

戻り値

変更された文字列へのポインターを返します。

解説

_strnset 関数は、str の最初の count の文字数までを c に設定します (char に変換)。 count が str の長さを超えると、str の長さが count の代わりに使用されます。

_wcsnset 関数と _mbsnset 関数は、_strnset 関数のワイド文字バージョンとマルチバイト文字バージョンです。 _wcsnset 関数の文字列引数と戻り値はワイド文字列で、_mbsnset 関数の文字列引数と戻り値はマルチバイト文字列です。それ以外では、これらの関数の動作は同じです。

_mbsnset 関数はそのパラメーターを検証します。str が null ポインターの場合は、「パラメーターの検証」に説明されているように、無効なパラメーターハンドラーが呼び出されます。実行の継続が許可された場合、_mbsnset は NULL を返し、errno を EINVAL に設定します。 _strnset および _wcsnset は、パラメーターを検証しません。

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

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tcsnset	_strnset	_mbsnbset	_wcsnset
_tcsnset_l	_strnset_l	_mbsnbset_l	_wcsnset_l

必要条件

ルーチン	必須ヘッダー
_strnset	<string.h>
_strnset_l	<tchar.h>
_wcsnset	<string.h> または <wchar.h>
_wcsnset_l	<tchar.h>
_mbsnset, _mbsnset_l	<mbstring.h>

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

使用例

// crt_strnset.c
// compile with: /W3
#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( string, '*', 4 ); // C4996
   // Note: _strnset is deprecated; consider using _strnset_s
   printf( "After:  %s\n", string );
}