_mbsnbcat_s、_mbsnbcat_s_l

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

更新 : 2007 年 11 月

1 つのマルチバイト文字列の最初の n バイトを別の文字列の末尾に追加します。これらの関数は、「CRT のセキュリティ強化」に説明されているように、_mbsnbcat、_mbsnbcat_l のセキュリティが強化されたバージョンです。

errno_t _mbsnbcat_s(
   unsigned char *dest,
   size_t sizeInBytes,
   const unsigned char *src,
   size_t count 
);
errno_t _mbsnbcat_s_l(
   unsigned char *dest,
   size_t sizeInBytes,
   const unsigned char *src,
   size_t count,
   _locale_t locale
);
template <size_t size>
errno_t _mbsnbcat_s(
   unsigned char (&dest)[size],
   const unsigned char *src,
   size_t count 
); // C++ only
template <size_t size>
errno_t _mbsnbcat_s_l(
   unsigned char (&dest)[size],
   const unsigned char *src,
   size_t count,
   _locale_t locale
); // C++ only

パラメータ

dest
追加先の、NULL で終わるマルチバイト文字列。
sizeInBytes
dest バッファのサイズ (バイト単位)。
src
追加元の、NULL で終わるマルチバイト文字列。
Count
dest に追加する src からのバイト数。
locale
使用するロケール。

戻り値

正常終了した場合は 0 を返し、それ以外の場合はエラーコードを返します。

エラー条件

Dest	sizeInBytes	src	戻り値
NULL	any	any	EINVAL
どれでも可	<= 0	any	EINVAL
どれでも可	any	NULL	EINVAL

上記のいずれかのエラー条件が発生すると、この関数は「パラメータの検証」に説明されているように、無効なパラメータエラーを呼び出します。エラーが処理されると、この関数は EINVAL を返し、errno を EINVAL に設定します。

解説

mbsnbcat_s 関数は、src の最初の count のバイト数までを dest に追加します。dest の null 文字の直前にあるバイトが先行バイトの場合は、src の先頭のバイトによって、その先行バイトが上書きされます。それ以外の場合は、src の先頭のバイトによって dest の終端の null 文字が上書きされます。count のバイト数が追加される前に src に null バイトがあった場合、_mbsnbcat_s は、src の null 文字までのすべてのバイトを追加します。count が src の長さを超えると、src の長さが count の代わりに使用されます。結果の文字列は、NULL 文字で終了します。重なり合う文字列間でコピーした場合の動作は未定義です。

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

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

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

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