strcpy_s、wcscpy_s、_mbscpy_s

[アーティクル]
03/26/2013

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

重要
_mbscpy_s は、Windows のランタイムで実行するアプリケーションで使用することはできません。詳細については、でサポート /ZW CRT 関数" "を参照してください。

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 で終わる元の文字列バッファー。

戻り値

正常終了した場合はゼロ; 別の方法でエラー。

エラー条件

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

解説

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

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

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

成功した実行に、終わる追加先の文字列は常に null です。

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

これらの関数のデバッグバージョンは、最初に 0xFE のバッファーに格納します。この動作を無効にするには、_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 );
}

同等の .NET Framework 関数

System::String::Copy

次の方法で共有

strcpy_s、wcscpy_s、_mbscpy_s

パラメーター

戻り値

解説

必要条件

使用例

同等の .NET Framework 関数

参照

関連項目

その他のリソース