_strnset_s、_strnset_s_l、_wcsnset_s、_wcsnset_s_l、_mbsnset_s、_mbsnset_s_l
文字列の文字を所定の書式に初期化します。これらの関数は、「CRT のセキュリティ機能」に説明されているように、_strnset、_strnset_l、_wcsnset、_wcsnset_l、_mbsnset、_mbsnset_l のセキュリティが強化されたバージョンです。
.gif "重要 :") 重要 |
|---|
_mbsnset_s と _mbsnset_s_l は、Windows のランタイムで実行するアプリケーションで使用することはできません。詳細については、でサポート /ZW CRT 関数" "を参照してください。 |
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 以下である場合は、「パラメーターの検証」で説明されているように、無効なパラメーター ハンドラーが呼び出されます。実行の続行が許可された場合、これらの関数はエラー コードを返し、errno をそのエラー コードに設定します。特定の値が適用される場合を除いて、既定のエラー コードは EINVAL です。
解説
これらの関数は、str の最初の count 文字数までを c に設定します。count が str のサイズを超えると、その str のサイズが count の代わりに使用されます。count の値が numberOfElements を超え、この両方のパラメーターが str のサイズを超えると、エラーが発生します。
_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 );
}