2004-11-03 13:51:07 +00:00
|
|
|
.\" Hey Emacs! This file is -*- nroff -*- source.
|
|
|
|
.\"
|
|
|
|
.\" Copyright 1995 James R. Van Zandt <jrv@vanzandt.mv.com>
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
2010-09-15 07:05:46 +00:00
|
|
|
.TH STPCPY 3 2010-09-15 "GNU" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
stpcpy \- copy a string returning a pointer to its end
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <string.h>
|
|
|
|
.sp
|
|
|
|
.BI "char *stpcpy(char *" dest ", const char *" src );
|
|
|
|
.fi
|
2010-09-15 07:05:46 +00:00
|
|
|
.sp
|
|
|
|
.in -4n
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
|
|
.BR feature_test_macros (7)):
|
|
|
|
.in
|
|
|
|
.sp
|
|
|
|
.BR stpcpy ():
|
faccessat.2, dprintf.3, fexecve.3, fmemopen.3, mbsnrtowcs.3, mkfifoat.3, opendir.3, stpcpy.3, stpncpy.3, strnlen.3, strsignal.3, wcpcpy.3, wcpncpy.3, wcscasecmp.3, wcsdup.3, wcsncasecmp.3, wcsnlen.3, wcsnrtombs.3: ffix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-19 16:57:10 +00:00
|
|
|
.PD 0
|
|
|
|
.ad l
|
|
|
|
.RS 4
|
|
|
|
.TP 4
|
|
|
|
Since glibc 2.10:
|
|
|
|
_XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
|
|
|
|
.TP
|
2010-09-15 07:05:46 +00:00
|
|
|
Before glibc 2.10:
|
|
|
|
_GNU_SOURCE
|
faccessat.2, dprintf.3, fexecve.3, fmemopen.3, mbsnrtowcs.3, mkfifoat.3, opendir.3, stpcpy.3, stpncpy.3, strnlen.3, strsignal.3, wcpcpy.3, wcpncpy.3, wcscasecmp.3, wcsdup.3, wcsncasecmp.3, wcsnlen.3, wcsnrtombs.3: ffix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-19 16:57:10 +00:00
|
|
|
.RE
|
|
|
|
.ad
|
|
|
|
.PD
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR stpcpy ()
|
|
|
|
function copies the string pointed to by \fIsrc\fP
|
2008-06-09 15:49:35 +00:00
|
|
|
(including the terminating \(aq\\0\(aq character) to the array pointed to by
|
2007-04-24 16:44:51 +00:00
|
|
|
\fIdest\fP.
|
|
|
|
The strings may not overlap, and the destination string
|
2004-11-03 13:51:07 +00:00
|
|
|
\fIdest\fP must be large enough to receive the copy.
|
|
|
|
.SH "RETURN VALUE"
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR stpcpy ()
|
|
|
|
returns a pointer to the \fBend\fP of the string
|
2006-01-13 02:09:44 +00:00
|
|
|
\fIdest\fP (that is, the address of the terminating null byte)
|
2004-11-03 13:51:07 +00:00
|
|
|
rather than the beginning.
|
2007-05-19 04:30:20 +00:00
|
|
|
.SH "CONFORMING TO"
|
|
|
|
This function is not part of the C or POSIX.1 standards, and is
|
intro.1, time.1, accept.2, bind.2, connect.2, execve.2, flock.2, getdents.2, getpriority.2, getuid.2, intro.2, ioctl.2, mincore.2, mknod.2, personality.2, ptrace.2, read.2, recv.2, select_tut.2, send.2, sendfile.2, shmctl.2, sigaction.2, signal.2, stat.2, times.2, truncate.2, umask.2, wait.2, MB_CUR_MAX.3, MB_LEN_MAX.3, argz_add.3, btowc.3, clearenv.3, clock.3, cmsg.3, end.3, endian.3, errno.3, exit.3, fgetwc.3, fgetws.3, fopen.3, fputwc.3, fputws.3, fseek.3, fwide.3, getfsent.3, getgrnam.3, gethostid.3, getipnodebyname.3, getmntent.3, getpwnam.3, getwchar.3, grantpt.3, iconv.3, iconv_close.3, iconv_open.3, insque.3, intro.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mkstemp.3, mktemp.3, nl_langinfo.3, openpty.3, posix_openpt.3, printf.3, ptsname.3, putwchar.3, qecvt.3, rcmd.3, readdir.3, rexec.3, rpc.3, setnetgrent.3, shm_open.3, sigpause.3, stdin.3, stpcpy.3, strftime.3, strptime.3, syslog.3, towctrans.3, towlower.3, towupper.3, ttyslot.3, ungetwc.3, unlocked_stdio.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wprintf.3, console_ioctl.4, pts.4, elf.5, filesystems.5, hosts.5, proc.5, ttytype.5, boot.7, capabilities.7, credentials.7, epoll.7, glob.7, koi8-r.7, path_resolution.7, pty.7, signal.7, suffixes.7, time.7, unicode.7, unix.7, uri.7, utf-8.7: global fix: s/Unix/UNIX/
The man pages were rather inconsistent in the use of "Unix"
versus "UNIX". Let's go with the trademark usage.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-12 04:45:38 +00:00
|
|
|
not customary on UNIX systems, but is not a GNU invention either.
|
2007-05-19 04:30:20 +00:00
|
|
|
Perhaps it comes from MS-DOS.
|
2009-02-02 21:20:02 +00:00
|
|
|
Nowadays, it is also present on the BSDs.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH EXAMPLE
|
2007-05-12 09:06:04 +00:00
|
|
|
For example, this program uses
|
|
|
|
.BR stpcpy ()
|
|
|
|
to concatenate \fBfoo\fP and
|
2004-11-03 13:51:07 +00:00
|
|
|
\fBbar\fP to produce \fBfoobar\fP, which it then prints.
|
2007-12-19 06:57:44 +00:00
|
|
|
.in +4n
|
2004-11-03 13:51:07 +00:00
|
|
|
.nf
|
|
|
|
|
2009-02-02 21:25:32 +00:00
|
|
|
#define _GNU_SOURCE
|
2007-05-19 04:30:20 +00:00
|
|
|
#include <string.h>
|
2009-02-02 21:25:32 +00:00
|
|
|
#include <stdio.h>
|
2004-11-03 13:51:07 +00:00
|
|
|
|
2007-05-19 04:30:20 +00:00
|
|
|
int
|
2009-02-02 21:21:05 +00:00
|
|
|
main(void)
|
2007-05-19 04:30:20 +00:00
|
|
|
{
|
2009-02-02 21:25:32 +00:00
|
|
|
char buffer[20];
|
2007-05-19 04:30:20 +00:00
|
|
|
char *to = buffer;
|
2009-02-02 21:25:32 +00:00
|
|
|
|
2007-05-19 04:30:20 +00:00
|
|
|
to = stpcpy(to, "foo");
|
|
|
|
to = stpcpy(to, "bar");
|
|
|
|
printf("%s\\n", buffer);
|
|
|
|
}
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
2007-05-19 04:30:20 +00:00
|
|
|
.in
|
2009-02-02 21:27:11 +00:00
|
|
|
.SH BUGS
|
|
|
|
This function may overrun the buffer
|
|
|
|
.IR dest .
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR bcopy (3),
|
|
|
|
.BR memccpy (3),
|
|
|
|
.BR memcpy (3),
|
|
|
|
.BR memmove (3),
|
2006-02-09 20:57:44 +00:00
|
|
|
.BR strcpy (3),
|
index.3, stpcpy.3, strcasecmp.3, strcat.3, strchr.3, strcmp.3, strcoll.3, strcpy.3, strdup.3, strfry.3, strpbrk.3, strsep.3, strspn.3, strstr.3, strtok.3, strxfrm.3: SEE ALSO: Add reference to string(3)
The idea here is to provide a route to discover other
string functions.
Reported-by: Mark Hills <mark@pogo.org.uk>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-12 14:39:58 +00:00
|
|
|
.BR string (3),
|
2007-01-28 20:00:24 +00:00
|
|
|
.BR wcpcpy (3),
|
|
|
|
.BR feature_test_macros (7)
|