diff options
Diffstat (limited to '')
| -rw-r--r-- | libabort_stpacpy.3 | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/libabort_stpacpy.3 b/libabort_stpacpy.3 new file mode 100644 index 0000000..3de9ea1 --- /dev/null +++ b/libabort_stpacpy.3 @@ -0,0 +1,56 @@ +.TH LIBABORT_STPACPY 3 LIBABORT +.SH NAME +libabort_stpacpy \- Copy a string with bounds checking + +.SH SYNOPSIS +.nf +#include <libabort.h> + +char *\fBlibabort_stpacpy\fP(char *\fIdst\fP, const char *\fIsrc\fP, size_t \fIsize\fP); + +#if !defined(LIBABORT_NO_SHORTHANDS) && !defined(stpacpy) +# define \fBstpacpy\fP libabort_stpacpy +#endif +.fi +.PP +Link with +.IR -labort . + +.SH DESCRIPTION +The +.BR libabort_stpacpy () +function copies the NUL terminated string +.I src +into the buffer +.IR dst , +which is assumed to be +.I size +bytes long. +.PP +If the string does not fit in the destination buffer +(including the terminating NUL byte), the +.BR libabort_stpacpy () +function calls +.BR abort (3). + +.SH RETURN VALUE +The +.BR libabort_stpacpy () +function returns a pointer to the terminating NUL byte in +.IR dst . + +.SH ERRORS +The +.BR libabort_stpacpy () +function cannot fail. + +.SH HISTORY +The +.BR libabort_stpacpy () +function added in version 1.0 of +.BR libabort . + +.SH SEE ALSO +.BR libabort (7), +.BR libabort_stracpy (3), +.BR libabort_stpacat (3) |
