_mbsnbcpy_s、_mbsnbcpy_s_l

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

更新 : 2007 年 11 月

文字列の n バイトを他の文字列にコピーします。これらの関数は、「CRT のセキュリティ強化」に説明されているように、_mbsnbcpy、_mbsnbcpy_l のセキュリティが強化されたバージョンです。

errno_t _mbsnbcpy_s(
   unsigned char * strDest,
   size_t sizeInBytes,
   const unsigned char * strSource,
   size_t count 
);
errno_t _mbsnbcpy_s_l(
   unsigned char * strDest,
   size_t sizeInBytes,
   const unsigned char * strSource,
   size_t count,
   _locale_t locale
);
template <size_t size>
errno_t _mbsnbcpy_s(
   unsigned char (&strDest)[size],
   const unsigned char * strSource,
   size_t count 
); // C++ only
template <size_t size>
errno_t _mbsnbcpy_s_l(
   unsigned char (&strDest)[size],
   const unsigned char * strSource,
   size_t count,
   _locale_t locale
); // C++ only

パラメータ

strDest
文字列のコピー先。
sizeInBytes
コピー先のバッファサイズ。
strSource
コピーする文字列。
count
コピー対象のバイト数。
locale
使用するロケール。

戻り値

正常終了した場合は 0 を返します。不適切なパラメータが渡された場合は EINVAL を返します。

解説

_mbsnbcpy_s 関数は、count バイト数を strSource から strDest にコピーします。count が strDest のサイズを超える場合、入力文字列のいずれかが null ポインタの場合、sizeInBytes または count が 0 の場合、この関数は「パラメータの検証」に説明されているように、無効なパラメータハンドラを呼び出します。実行の継続が許可された場合、関数は EINVAL を返します。コピー元とコピー先の文字列が重なり合う場合の _mbstrncpy の動作は未定義です。

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

メモ :
この関数のセキュリティが万全ではないバージョンとは異なり、_mbsnbcpy_s 関数では null の埋め込みが一切行われず、文字列は必ず null で終わります。

C++ では、これらの関数の使用はテンプレートのオーバーロードによって簡素化されます。オーバーロードでは、バッファ長を自動的に推論できる (サイズの引数を指定する必要がなくなる) だけでなく、古くてセキュリティが万全ではない関数を新しく安全な関数に自動的に置き換えることができます。詳細については、「セキュリティ保護されたテンプレートオーバーロード」を参照してください。

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

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