_mbsnbset_s、_mbsnbset_s_l
更新 : 2007 年 11 月
マルチバイト文字列の最初の n バイトを指定された文字に設定します。これらの関数は、「CRT のセキュリティ強化」に説明されているように、_mbsnbset、_mbsnbset_l のセキュリティが強化されたバージョンです。
errno_t _mbsnbset_s(
unsigned char *str,
size_t size,
unsigned int c,
size_t count
);
errno_t _mbsnbset_s_l(
unsigned char *str,
size_t size,
unsigned int c,
size_t count,
_locale_t locale
);
template <size_t size>
errno_t _mbsnbset_s(
unsigned char (&str)[size],
unsigned int c,
size_t count
); // C++ only
template <size_t size>
errno_t _mbsnbset_s_l(
unsigned char (&str)[size],
unsigned int c,
size_t count,
_locale_t locale
); // C++ only
パラメータ
str
変更対象の文字列。size
文字列バッファのサイズ。c
1 バイト文字またはマルチバイト文字の設定。count
設定するバイト数。locale
使用するロケール。
戻り値
正常終了した場合は 0 を返し、それ以外の場合はエラー コードを返します。
解説
_mbsnbset_s 関数と _mbsnbset_s_l 関数は、str の最初の count バイト数までを c に設定します。count が str の長さを超えると、str の長さが count の代わりに使用されます。c がマルチバイト文字であり、count で指定された最終バイトまで完全に設定できない場合は、最終バイトに空白文字が埋め込まれます。_mbsnbset_s 関数と _mbsnbset_s_l 関数は、str の最後に終端の null を配置しません。
_mbsnbset_s 関数と _mbsnbset_s_l 関数は、c について count 文字数ではなく、count バイト数で設定します。この点以外は、_mbsnset 関数の動作と同じです。
str が NULL の場合または count が 0 の場合、「パラメータの検証」に説明されているように、この関数は無効なパラメータの例外を生成します。実行の継続が許可された場合、errno が EINVAL に設定され、関数から NULL が返されます。また、 c が有効なマルチバイト文字ではない場合、errno が EINVAL に設定され、代わりに空白が使用されます。
出力値は、ロケールの LC_CTYPE カテゴリの設定で決まります。詳細については、「setlocale」を参照してください。この関数の _mbsnbset_s バージョンは、現在のロケールを使用してこのロケール依存の動作を行います。_mbsnbset_s_l バージョンは、渡されたロケール パラメータを代わりに使用する点を除いて同じです。詳細については、「ロケール」を参照してください。
C++ では、これらの関数の使用はテンプレートのオーバーロードによって簡素化されます。オーバーロードでは、バッファ長を自動的に推論できるため、サイズの引数を指定する必要がなくなります。詳細については、「セキュリティ保護されたテンプレート オーバーロード」を参照してください。
これらの関数のデバッグ バージョンは、最初にバッファを 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 |
必要条件
ルーチン |
必須ヘッダー |
|---|---|
_mbsnbset_s |
<mbstring.h> |
_mbsnbset_s_l |
<mbstring.h> |
互換性の詳細については、「C ランタイム ライブラリ」の「互換性」を参照してください。
使用例
// crt_mbsnbset_s.c
#include <mbstring.h>
#include <stdio.h>
int main( void )
{
char string[15] = "This is a test";
/* Set not more than 4 bytes of string to be *'s */
printf( "Before: %s\n", string );
_mbsnbset_s( string, sizeof(string), '*', 4 );
printf( "After: %s\n", string );
}
出力
Before: This is a test
After: **** is a test
.NET Framework の相当するアイテム
適用できません。標準 C 関数を呼び出すには、PInvoke を使用します。詳細については、「プラットフォーム呼び出しの例」を参照してください。