strcpy_s、wcscpy_s、_mbscpy_s

[アーティクル]
06/09/2015

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

重要

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

戻り値

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

エラー条件

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

解説

strcpy_s 関数は、strSource のアドレスの内容を、終端の NULL 文字も含めて、strDestination で指定された場所にコピーします。コピー先の文字列には、コピー元の文字列とその終端の NULL 文字を保持できるサイズが必要です。コピー元とコピー先の文字列が重なり合っている場合の strcpy_s 関数の動作は未定義です。

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

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

正常に実行されると、コピー先の文字列は常に 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>

互換性の詳細については、「互換性」を参照してください。

使用例

// 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 関数

参照

関連項目

その他のリソース