strcpy, strcpy_s

 

C

言語

ヘッダ

型サポート

プログラムユーティリティ

可変長引数サポート

エラー処理

動的メモリ管理

日付と時間のユーティリティ

文字列ライブラリ

アルゴリズム

数値演算

入出力サポート

ローカライゼーションサポート

アトミック操作 (C11)

スレッドサポート (C11)

技術仕様書

 

文字列ライブラリ

バイト文字列

マルチバイト文字列

ワイド文字列

 

ヌル終端バイト文字列

関数
文字操作
isalnum isalpha islower isupper isdigit isxdigit isblank (C99)	iscntrl isgraph isspace isprint ispunct tolower toupper
数値形式への変換
atof atoiatolatoll (C99) strtolstrtoll (C99)	strtoulstrtoull (C99) strtofstrtodstrtold (C99)(C99) strtoimaxstrtoumax (C99)(C99)
文字列操作
strcpystrcpy_s (C11)
strncpystrncpy_s (C11)
strcatstrcat_s (C11)
strncatstrncat_s (C11)
strxfrm
strdup (C2x以上)
strndup (C2x以上)
文字列検査
strlenstrnlen_s (C11) strcmp strncmp strcoll strchr strrchr	strspn strcspn strpbrk strstr strtokstrtok_s (C11)
メモリ操作
memchr
memcmp
memsetmemset_s (C11)
memcpymemcpy_s (C11)
memmovememmove_s (C11)
memccpy (C2x以上)
その他
strerrorstrerror_sstrerrorlen_s (C11)(C11)

 

<tbody> </tbody> <tbody class="t-dcl-rev t-dcl-rev-num "> </tbody><tbody> </tbody>

ヘッダ <string.h> で定義
	(1)
char *strcpy( char *dest, const char *src );		(C99未満)
char *strcpy( char *restrict dest, const char *restrict src );		(C99以上)
errno_t strcpy_s(char *restrict dest, rsize_t destsz, const char *restrict src);	(2)	(C11以上)

1) src の指す文字列を、ヌル終端も含めて、 dest によって最初の要素が指されている文字配列にコピーします。

dest 配列が十分大きくない場合、動作は未定義です。 文字列がオーバーラップしている場合、動作は未定義です。 dest が文字配列を指していない、または src がヌル終端バイト文字列を指していない場合、動作は未定義です。

2) (1) と同じですが、格納先の配列の残りを未規定の値で上書きするかもしれず、以下のエラーが実行時に検出され、現在設定されている制約ハンドラ関数を呼びます。

• src または dest がヌルポインタ。
• destsz がゼロまたは RSIZE_MAX より大きい。
• destsz が strnlen_s(src, destsz) より小さいまたは等しい、別の言い方をすると、切り捨てが発生する。
• コピー元とコピー先の文字列の間でオーバーラップが発生する。

dest の指す文字配列のサイズ <= strnlen_s(src, destsz) < destsz の場合、動作は未定義です。 別の言い方をすると、 destsz の誤った値は切迫したバッファオーバーフローを露呈しません。

すべての境界チェック付き関数と同様に、 strcpy_s は __STDC_LIB_EXT1__ が処理系によって定義されていて、 <string.h> をインクルードする前にユーザが __STDC_WANT_LIB_EXT1__ を整数定数 1 に定義した場合にのみ、利用可能であることが保証されます。

引数

dest	-	書き込む文字配列を指すポインタ
src	-	コピーするヌル終端バイト文字列を指すポインタ
destsz	-	書き込む最大文字数、一般的にはコピー先バッファのサイズ

戻り値

1) dest のコピーを返します。

2) 成功した場合はゼロ、エラーが発生した場合は非ゼロを返します。 また、エラーの場合は dest[0] にゼロを書き込みます (dest がヌルポインタでなく、 destsz がゼロでなく RSIZE_MAX より大きくなければ)。

ノート

strcpy_s は効率向上のためにコピー先配列の書き込まれた最後の文字から destsz までを上書きすることが許されています。 複数バイトのブロックをコピーしてからヌルのバイトをチェックするかもしれません。

関数 strcpy_s は BSD の関数 strlcpy と同様ですが、以下の点が異なります。

• strlcpy はコピー元文字列をコピー先に収まるように切り捨てます (これはセキュリティリスクになります)。
• strlcpy は strcpy_s が行うすべての実行時のチェックを行いません。
• strlcpy は失敗時にコピー先にヌル文字列を設定したりハンドラを呼ぶことで失敗を明らかにしません。

strcpy_s は潜在的なセキュリティリスクのため切り捨てを禁止していますが、代わりに境界チェック付きの strncpy を使用すれば文字列を切り捨てることができます。

例

Run this code

#define __STDC_WANT_LIB_EXT1__ 1
#include <string.h>
#include <stdio.h>
#include <stdlib.h>

int main(void)
{
    char *src = "Take the test.";
//  src[0] = 'M' ; // this would be undefined behavior
    char dst[strlen(src) + 1]; // +1 to accomodate for the null terminator
    strcpy(dst, src);
    dst[0] = 'M'; // OK
    printf("src = %s\ndst = %s\n", src, dst);

#ifdef __STDC_LIB_EXT1__
    set_constraint_handler_s(ignore_handler_s);
    int r = strcpy_s(dst, sizeof dst, src);
    printf("dst = \"%s\", r = %d\n", dst, r);
    r = strcpy_s(dst, sizeof dst, "Take even more tests.");
    printf("dst = \"%s\", r = %d\n", dst, r);
#endif
}

出力例:

src = Take the test.
dst = Make the test.
dst = "Take the test.", r = 0
dst = "", r = 22

参考文献

• C11 standard (ISO/IEC 9899:2011):

• 7.24.2.3 The strcpy function (p: 363)

• K.3.7.1.3 The strcpy_s function (p: 615-616)

• C99 standard (ISO/IEC 9899:1999):

• 7.21.2.3 The strcpy function (p: 326)

• C89/C90 standard (ISO/IEC 9899:1990):

• 4.11.2.3 The strcpy function

関連項目

strncpystrncpy_s (C11)	文字列から別の文字列へ文字を一定量コピーします (関数)
memcpymemcpy_s (C11)	バッファを別のバッファへコピーします (関数)
wcscpywcscpy_s (C95)(C11)	ワイド文字列を別のワイド文字列にコピーします (関数)
strdup (dynamic memory TR)	文字列のコピーを確保します (関数)
strcpy の C++リファレンス