2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
|
|
|
|
.\"
|
|
|
|
.\" This is free documentation; you can redistribute it and/or
|
|
|
|
.\" modify it under the terms of the GNU General Public License as
|
|
|
|
.\" published by the Free Software Foundation; either version 2 of
|
|
|
|
.\" the License, or (at your option) any later version.
|
|
|
|
.\"
|
|
|
|
.\" References consulted:
|
|
|
|
.\" GNU glibc-2 source code and manual
|
|
|
|
.\"
|
|
|
|
.\" Corrected, aeb, 990824
|
|
|
|
.TH STPNCPY 3 1999-07-25 "GNU" "Linux Programmer's Manual"
|
|
|
|
.SH NAME
|
|
|
|
stpncpy \- copy a fixed-size string, returning a pointer to its end
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #define _GNU_SOURCE
|
|
|
|
.br
|
|
|
|
.B #include <string.h>
|
|
|
|
.sp
|
|
|
|
.BI "char *stpncpy(char *" dest ", const char *" src ", size_t " n );
|
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
2005-10-19 06:54:38 +00:00
|
|
|
The \fBstpncpy\fP() function copies at most \fIn\fP characters from the string
|
2004-11-03 13:51:07 +00:00
|
|
|
pointed to by \fIsrc\fP, including the terminating '\\0' character, to the
|
|
|
|
array pointed to by \fIdest\fP. Exactly \fIn\fP characters are written at
|
|
|
|
\fIdest\fP. If the length \fIstrlen(src)\fP is smaller than \fIn\fP, the
|
|
|
|
remaining characters in the array pointed to by \fIdest\fP are filled
|
|
|
|
with '\\0' characters. If the length \fIstrlen(src)\fP is greater or equal to
|
|
|
|
\fIn\fP, the string pointed to by \fIdest\fP will not be '\\0' terminated.
|
|
|
|
.PP
|
|
|
|
The strings may not overlap.
|
|
|
|
.PP
|
|
|
|
The programmer must ensure that there is room for at least \fIn\fP characters
|
|
|
|
at \fIdest\fP.
|
|
|
|
.SH "RETURN VALUE"
|
2005-10-19 06:54:38 +00:00
|
|
|
\fBstpncpy\fP() returns a pointer to the terminating null
|
2004-11-03 13:51:07 +00:00
|
|
|
in \fIdest\fP, or, if \fIdest\fP is not null-terminated,
|
|
|
|
\fIdest + n\fP.
|
|
|
|
.SH "CONFORMING TO"
|
|
|
|
This function is a GNU extension.
|
|
|
|
.SH "SEE ALSO"
|
2006-02-09 20:57:44 +00:00
|
|
|
.BR strncpy (3),
|
|
|
|
.BR wcpncpy (3)
|