strcpy_s、wcscpy_s、_mbscpy_s

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

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

errno_t strcpy_s(
   char *strDestination,
   size_t numberOfElements,
   const char *strSource 
);
errno_t wcscpy_s(
   wchar_t *strDestination,
   size_t numberOfElements,
   const wchar_t *strSource 
);
errno_t _mbscpy_s(
   unsigned char *strDestination,
   size_t numberOfElements,
   const unsigned char *strSource 
);
template <size_t size>
errno_t strcpy_s(
   char (&strDestination)[size],
   const char *strSource 
); // C++ only
template <size_t size>
errno_t wcscpy_s(
   wchar_t (&strDestination)[size],
   const wchar_t *strSource 
); // C++ only
template <size_t size>
errno_t _mbscpy_s(
   unsigned char (&strDestination)[size],
   const unsigned char *strSource 
); // C++ only

パラメーター

strDestination
コピー先の文字列バッファーの場所。
numberOfElements
コピー先の文字列バッファーのサイズ。
strSource
null で終わる元の文字列バッファー。

戻り値

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

エラー条件

strDestination	numberOfElements	strSource	戻り値	strDestination の内容
NULL	any	any	EINVAL	変更されない
any	any	NULL	EINVAL	strDestination[0] が 0 に設定される
any	0 または小さすぎる	any	ERANGE	strDestination[0] が 0 に設定される

解説

strcpy_s 関数は、終端の null 文字を含めて、strSource のアドレス内の内容を、strDestination で指定された位置にコピーします。コピー先の文字列は、終端 null 文字も含めて元の文字列を格納できるだけの大きさである必要があります。コピー元とコピー先の文字列が重なり合っている場合の strcpy_s 関数の動作は未定義です。

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

strDestination または strSource が null ポインターの場合、またはコピー先文字列が小さすぎる場合は、「パラメーターの検証」に説明されているように、無効なパラメーターハンドラーが呼び出されます。実行の継続が許可された場合、これらの関数は EINVAL を返し、errno を EINVAL に設定します。

実行が成功した場合、コピー先文字列は必ず null で終わります。

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

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

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

TCHAR.H のルーチン	_UNICODE および _MBCS が未定義の場合	_MBCS が定義されている場合	_UNICODE が定義されている場合
_tcscpy_s	strcpy_s	_mbscpy_s	wcscpy_s

必要条件

ルーチン	必須ヘッダー
strcpy_s	<string.h>
wcscpy_s	<string.h> または <wchar.h>
_mbscpy_s	<mbstring.h>

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

使用例

// crt_strcpy_s.cpp
// This program uses strcpy_s and strcat_s
// to build a phrase.
//

#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <errno.h>

int main( void )
{
   char string[80];
   // using template versions of strcpy_s and strcat_s:
   strcpy_s( string, "Hello world from " );
   strcat_s( string, "strcpy_s " );
   strcat_s( string, "and " );
   // of course we can supply the size explicitly if we want to:
   strcat_s( string, _countof(string), "strcat_s!" );
   
   printf( "String = %s\n", string );
}