The Open Group Base Specifications Issue 7
IEEE Std 1003.1, 2013 Edition
Copyright © 2001-2013 The IEEE and The Open Group

NAME

stpcpy, strcpy - copy a string and return a pointer to the end of the result

SYNOPSIS

#include <string.h>

[CX] [Option Start] char *stpcpy(char *restrict s1, const char *restrict s2); [Option End]

char *strcpy(char *restrict
s1, const char *restrict s2);

DESCRIPTION

For strcpy(): [CX] [Option Start]  The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of POSIX.1-2008 defers to the ISO C standard. [Option End]

The [CX] [Option Start] stpcpy() [Option End]  and strcpy() functions shall copy the string pointed to by s2 (including the terminating NUL character) into the array pointed to by s1.

If copying takes place between objects that overlap, the behavior is undefined.

RETURN VALUE

[CX] [Option Start] The stpcpy() function shall return a pointer to the terminating NUL character copied into the s1 buffer. [Option End]

The strcpy() function shall return s1.

No return values are reserved to indicate an error.

ERRORS

No errors are defined.


The following sections are informative.

EXAMPLES

Construction of a Multi-Part Message in a Single Buffer
#include <string.h>
#include <stdio.h>

int main (void) { char buffer [10]; char *name = buffer;
name = stpcpy (stpcpy (stpcpy (name, "ice"),"-"), "cream"); puts (buffer); return 0; }
Initializing a String

The following example copies the string "----------" into the permstring variable.

#include <string.h>
...
static char permstring[11];
...
strcpy(permstring, "----------");
...

Storing a Key and Data

The following example allocates space for a key using malloc() then uses strcpy() to place the key there. Then it allocates space for data using malloc(), and uses strcpy() to place data there. (The user-defined function dbfree() frees memory previously allocated to an array of type struct element *.)

#include <string.h>
#include <stdlib.h>
#include <stdio.h>
...
/* Structure used to read data and store it. */
struct element {
    char *key;
    char *data;
};

struct element *tbl, *curtbl; char *key, *data; int count; ... void dbfree(struct element *, int); ... if ((curtbl->key = malloc(strlen(key) + 1)) == NULL) { perror("malloc"); dbfree(tbl, count); return NULL; } strcpy(curtbl->key, key);
if ((curtbl->data = malloc(strlen(data) + 1)) == NULL) { perror("malloc"); free(curtbl->key); dbfree(tbl, count); return NULL; } strcpy(curtbl->data, data); ...

APPLICATION USAGE

Character movement is performed differently in different implementations. Thus, overlapping moves may yield surprises.

This version is aligned with the ISO C standard; this does not affect compatibility with XPG3 applications. Reliable error detection by this function was never guaranteed.

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

strncpy, wcscpy

XBD <string.h>

CHANGE HISTORY

First released in Issue 1. Derived from Issue 1 of the SVID.

Issue 6

The strcpy() prototype is updated for alignment with the ISO/IEC 9899:1999 standard.

Issue 7

The stpcpy() function is added from The Open Group Technical Standard, 2006, Extended API Set Part 1.

End of informative text.

 

return to top of page

UNIX ® is a registered Trademark of The Open Group.
POSIX ® is a registered Trademark of The IEEE.
Copyright © 2001-2013 The IEEE and The Open Group, All Rights Reserved
[ Main Index | XBD | XSH | XCU | XRAT ]