Namespaces
Variants
Views
Actions

Difference between revisions of "c/string/byte/strcpy"

From cppreference.com
< c‎ | string‎ | byte
(fix typo using c++ version)
(C++error: Values of type 'const char *' cannot be used to initialize entities of type 'char *')
 
(18 intermediate revisions by 4 users not shown)
Line 12: Line 12:
 
{{dcl rev end}}
 
{{dcl rev end}}
 
{{dcl |num=2| since=c11 |
 
{{dcl |num=2| since=c11 |
−
errno_t strcpy_s(char *restrict dest, rsize_t destsz, const char *restrict src);
+
errno_t strcpy_s( char *restrict dest, rsize_t destsz, const char *restrict src );
 
}}
 
}}
 
{{dcl end}}
 
{{dcl end}}
  
−
@1@ Copies the character string pointed to by {{tt|src}}, including the null terminator to the character array whose first element is pointed to by {{tt|dest}}. The behavior is undefined if the {{tt|dest}} array is not large enough. The behavior is undefined if the strings overlap.
+
@1@ Copies the null-terminated byte string pointed to by {{tt|src}}, including the null terminator, to the character array whose first element is pointed to by {{tt|dest}}.
 +
@@The behavior is undefined if the {{tt|dest}} array is not large enough. The behavior is undefined if the strings overlap. The behavior is undefined if either {{tt|dest}} is not a pointer to a character array or {{tt|src}} is not a pointer to a null-terminated byte string.
 
@2@ Same as {{v|1}}, except that it may clobber the rest of the destination array with unspecified values and that the following errors are detected at runtime and call the currently installed [[c/error/set_constraint_handler_s|constraint handler]] function:
 
@2@ Same as {{v|1}}, except that it may clobber the rest of the destination array with unspecified values and that the following errors are detected at runtime and call the currently installed [[c/error/set_constraint_handler_s|constraint handler]] function:
 
:* {{tt|src}} or {{tt|dest}} is a null pointer
 
:* {{tt|src}} or {{tt|dest}} is a null pointer
 
:* {{tt|destsz}} is zero or greater than {{lc|RSIZE_MAX}}
 
:* {{tt|destsz}} is zero or greater than {{lc|RSIZE_MAX}}
−
:* {{tt|destsz}} is less or equal {{c|strnlen_s(src, destsz)}}, in other words, truncation would occur
+
:* {{tt|destsz}} is less or equal {{c|strnlen_s(src, destsz)}}; in other words, truncation would occur
 
:* overlap would occur between the source and the destination strings
 
:* overlap would occur between the source and the destination strings
−
:As all bounds-checked functions, {{tt|strcpy_s}} is only guaranteed to be available if {{c|__STDC_LIB_EXT1__}} is defined by the implementation and if the user defines {{c|__STDC_WANT_LIB_EXT1__}} to the integer constant {{c|1}} before including {{tt|string.h}}.
+
@@The behavior is undefined if the size of the character array pointed to by {{tt|dest}} <= {{c|strnlen_s(src, destsz)}} < {{tt|destsz}}; in other words, an erroneous value of {{tt|destsz}} does not expose the impending buffer overflow.
 +
:{{c/ext1 availability|strcpy_s}}
  
 
===Parameters===
 
===Parameters===
Line 33: Line 35:
 
===Return value===
 
===Return value===
 
@1@ returns a copy of {{tt|dest}}
 
@1@ returns a copy of {{tt|dest}}
−
@2@ returns zero on success, returns non-zero on error. Also, on error, writes zero to {{c|dest[0]}} (unless {{tt|dest}} is a null pointer or {{tt|destsz}} is zero or greater than {{lc|RMAX_SIZE}}).
+
@2@ returns zero on success, returns non-zero on error. Also, on error, writes zero to {{c|dest[0]}} (unless {{tt|dest}} is a null pointer or {{tt|destsz}} is zero or greater than {{lc|RSIZE_MAX}}).
  
 
===Notes===
 
===Notes===
Line 46: Line 48:
  
 
===Example===
 
===Example===
−
{{example | code=
+
{{example
 +
|code=
 +
#define __STDC_WANT_LIB_EXT1__ 1
 
#include <string.h>
 
#include <string.h>
 
#include <stdio.h>
 
#include <stdio.h>
 +
#include <stdlib.h>
  
 
int main(void)
 
int main(void)
 
{
 
{
−
     char *src = "Take the test.";
+
     const char *src = "Take the test.";
 
//  src[0] = 'M' ; // this would be undefined behavior
 
//  src[0] = 'M' ; // this would be undefined behavior
−
     char dst[strlen(src) + 1]; // +1 to accomodate for the null terminator
+
     char dst[strlen(src) + 1]; // +1 to accommodate for the null terminator
 
     strcpy(dst, src);
 
     strcpy(dst, src);
 
     dst[0] = 'M'; // OK
 
     dst[0] = 'M'; // OK
 
     printf("src = %s\ndst = %s\n", src, dst);
 
     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
 
}
 
}
−
| output=
+
|p=true
 +
|output=
 
src = Take the test.
 
src = Take the test.
 
dst = Make the test.
 
dst = Make the test.
 +
dst = "Take the test.", r = 0
 +
dst = "", r = 22
 
}}
 
}}
  
 
===References===
 
===References===
 +
{{ref std c17}}
 +
{{ref std | section=7.24.2.3  | title=The strcpy function | p=264-265}}
 +
{{ref std | section=K.3.7.1.3 | title=The strcpy_s function | p=447}}
 +
{{ref std end}}
 
{{ref std c11}}
 
{{ref std c11}}
 
{{ref std | section=7.24.2.3  | title=The strcpy function | p=363}}
 
{{ref std | section=7.24.2.3  | title=The strcpy function | p=363}}
 
{{ref std | section=K.3.7.1.3 | title=The strcpy_s function | p=615-616}}
 
{{ref std | section=K.3.7.1.3 | title=The strcpy_s function | p=615-616}}
 +
{{ref std end}}
 
{{ref std c99}}
 
{{ref std c99}}
 
{{ref std | section=7.21.2.3  | title=The strcpy function | p=326}}
 
{{ref std | section=7.21.2.3  | title=The strcpy function | p=326}}
 +
{{ref std end}}
 
{{ref std c89}}
 
{{ref std c89}}
−
{{ref std | section= | title= }}
+
{{ref std | section=4.11.2.3 | title=The strcpy function }}
 
{{ref std end}}
 
{{ref std end}}
  
Line 79: Line 101:
 
{{dsc inc | c/string/byte/dsc memcpy}}
 
{{dsc inc | c/string/byte/dsc memcpy}}
 
{{dsc inc | c/string/wide/dsc wcscpy}}
 
{{dsc inc | c/string/wide/dsc wcscpy}}
 +
{{dsc inc | c/experimental/dynamic/dsc strdup}}
 
{{dsc see cpp | cpp/string/byte/strcpy}}
 
{{dsc see cpp | cpp/string/byte/strcpy}}
 
{{dsc end}}
 
{{dsc end}}
  
−
[[ar:c/string/byte/strcpy]]
+
{{langlinks|ar|cs|de|es|fr|it|ja|ko|pl|pt|ru|tr|zh}}
−
[[cs:c/string/byte/strcpy]]
+
−
[[de:c/string/byte/strcpy]]
+
−
[[es:c/string/byte/strcpy]]
+
−
[[fr:c/string/byte/strcpy]]
+
−
[[it:c/string/byte/strcpy]]
+
−
[[ja:c/string/byte/strcpy]]
+
−
[[ko:c/string/byte/strcpy]]
+
−
[[pl:c/string/byte/strcpy]]
+
−
[[pt:c/string/byte/strcpy]]
+
−
[[ru:c/string/byte/strcpy]]
+
−
[[tr:c/string/byte/strcpy]]
+
−
[[zh:c/string/byte/strcpy]]
+

Latest revision as of 19:44, 30 July 2023

 
C
 
Strings library
 
Null-terminated byte strings
Functions
Character manipulation
Conversions to and from numeric formats
String manipulation
strcpystrcpy_s
(C11)
(C11)
(C11)
String examination
Memory manipulation
Miscellaneous
(C11)(C11)
 
Defined in header <string.h>
(1)
char *strcpy( char *dest, const char *src );
 (until C99)
char *strcpy( char *restrict dest, const char *restrict src );
 (since C99)
errno_t strcpy_s( char *restrict dest, rsize_t destsz, const char *restrict src );
 (2) (since C11)
1) Copies the null-terminated byte string pointed to by src, including the null terminator, to the character array whose first element is pointed to by dest.
The behavior is undefined if the dest array is not large enough. The behavior is undefined if the strings overlap. The behavior is undefined if either dest is not a pointer to a character array or src is not a pointer to a null-terminated byte string.
2) Same as (1), except that it may clobber the rest of the destination array with unspecified values and that the following errors are detected at runtime and call the currently installed constraint handler function:
  • src or dest is a null pointer
  • destsz is zero or greater than RSIZE_MAX
  • destsz is less or equal strnlen_s(src, destsz); in other words, truncation would occur
  • overlap would occur between the source and the destination strings
The behavior is undefined if the size of the character array pointed to by dest <= strnlen_s(src, destsz) < destsz; in other words, an erroneous value of destsz does not expose the impending buffer overflow.
As with all bounds-checked functions, strcpy_s is only guaranteed to be available if __STDC_LIB_EXT1__ is defined by the implementation and if the user defines __STDC_WANT_LIB_EXT1__ to the integer constant 1 before including <string.h>.

Contents

[edit] Parameters

dest - pointer to the character array to write to
src - pointer to the null-terminated byte string to copy from
destsz - maximum number of characters to write, typically the size of the destination buffer

[edit] Return value

1) returns a copy of dest
2) returns zero on success, returns non-zero on error. Also, on error, writes zero to dest[0] (unless dest is a null pointer or destsz is zero or greater than RSIZE_MAX).

[edit] Notes

strcpy_s is allowed to clobber the destination array from the last character written up to destsz in order to improve efficiency: it may copy in multibyte blocks and then check for null bytes.

The function strcpy_s is similar to the BSD function strlcpy, except that

  • strlcpy truncates the source string to fit in the destination (which is a security risk)
  • strlcpy does not perform all the runtime checks that strcpy_s does
  • strlcpy does not make failures obvious by setting the destination to a null string or calling a handler if the call fails.

Although strcpy_s prohibits truncation due to potential security risks, it's possible to truncate a string using bounds-checked strncpy_s instead.

[edit] Example

Run this code
#define __STDC_WANT_LIB_EXT1__ 1
#include <string.h>
#include <stdio.h>
#include <stdlib.h>
 
int main(void)
{
    const char *src = "Take the test.";
//  src[0] = 'M' ; // this would be undefined behavior
    char dst[strlen(src) + 1]; // +1 to accommodate 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
}

Possible output: 

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

[edit] References

  • C17 standard (ISO/IEC 9899:2018):
  • 7.24.2.3 The strcpy function (p: 264-265)
  • K.3.7.1.3 The strcpy_s function (p: 447)
  • 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

[edit] See also

(C11)
 copies a certain amount of characters from one string to another
(function) [edit]
(C11)
 copies one buffer to another
(function) [edit]
(C95)(C11)
 copies one wide string to another
(function) [edit]
(dynamic memory TR)
 allocate a copy of a string
(function) [edit]
C++ documentation for strcpy
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=c/string/byte/strcpy&oldid=155879"