aboutsummaryrefslogtreecommitdiffstats
path: root/man3/libsimple_stpmove.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--man3/libsimple_stpmove.374
1 files changed, 74 insertions, 0 deletions
diff --git a/man3/libsimple_stpmove.3 b/man3/libsimple_stpmove.3
new file mode 100644
index 0000000..5b28622
--- /dev/null
+++ b/man3/libsimple_stpmove.3
@@ -0,0 +1,74 @@
+.TH LIBSIMPLE_STPMOVE 3 2018-11-16 libsimple
+.SH NAME
+libsimple_stpmove \- move a string within an array of bytes
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+static inline void *libsimple_stpmove(void *\fIdest\fP, const void *\fIsrc\fP);
+
+#ifndef stpmove
+# define stpmove libsimple_stpmove
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_stpmove ()
+function copies the string, including the
+NUL byte that terminates it,
+.I src
+into
+.IR dest .
+The arrays may overlap.
+.SH RETURN VALUE
+The
+.BR libsimple_stpmove ()
+function returns the pointer
+.I dest
+with the offset of the length of string
+.I str
+(the address of the copied NUL byte in
+.IR dest ).
+.SH ERRORS
+The
+.BR libsimple_stpmove ()
+function cannot fail.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lb lb lb
+l l l.
+Interface Attribute Value
+T{
+.BR libsimple_stpmove ()
+T} Thread safety MT-Safe
+T{
+.BR libsimple_stpmove ()
+T} Async-signal safety AS-Safe
+T{
+.BR libsimple_stpmove ()
+T} Async-cancel safety AC-Safe
+.TE
+.SH EXAMPLES
+None.
+.SH APPLICATION USAGE
+None.
+.SH RATIONALE
+None.
+.SH FUTURE DIRECTIONS
+None.
+.SH NOTES
+None.
+.SH BUGS
+None.
+.SH SEE ALSO
+.BR libsimple_strmove (3),
+.BR libsimple_stpnmove (3),
+.BR libsimple_mempmove (3),
+.BR stpcpy (3),
+.BR memmove (3)