Blame man3/strsep.3

Packit 7cfc04
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of this
Packit 7cfc04
.\" manual under the conditions for verbatim copying, provided that the
Packit 7cfc04
.\" entire resulting derived work is distributed under the terms of a
Packit 7cfc04
.\" permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
Packit 7cfc04
.\" responsibility for errors or omissions, or for damages resulting from
Packit 7cfc04
.\" the use of the information contained herein.  The author(s) may not
Packit 7cfc04
.\" have taken the same level of care in the production of this manual,
Packit 7cfc04
.\" which is licensed free of charge, as they might when working
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.\" References consulted:
Packit 7cfc04
.\"     Linux libc source code
Packit 7cfc04
.\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
Packit 7cfc04
.\"     386BSD man pages
Packit 7cfc04
.\" Modified Sat Jul 24 18:00:10 1993 by Rik Faith (faith@cs.unc.edu)
Packit 7cfc04
.\" Modified Mon Jan 20 12:04:18 1997 by Andries Brouwer (aeb@cwi.nl)
Packit 7cfc04
.\" Modified Tue Jan 23 20:23:07 2001 by Andries Brouwer (aeb@cwi.nl)
Packit 7cfc04
.\"
Packit 7cfc04
.TH STRSEP 3  2016-03-15 "GNU" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
strsep \- extract token from string
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.nf
Packit 7cfc04
.B #include <string.h>
Packit 7cfc04
.PP
Packit 7cfc04
.BI "char *strsep(char **" stringp ", const char *" delim );
Packit 7cfc04
.fi
Packit 7cfc04
.PP
Packit 7cfc04
.in -4n
Packit 7cfc04
Feature Test Macro Requirements for glibc (see
Packit 7cfc04
.BR feature_test_macros (7)):
Packit 7cfc04
.in
Packit 7cfc04
.PP
Packit 7cfc04
.BR strsep ():
Packit 7cfc04
    Since glibc 2.19:
Packit 7cfc04
        _DEFAULT_SOURCE
Packit 7cfc04
    Glibc 2.19 and earlier:
Packit 7cfc04
        _BSD_SOURCE
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
If
Packit 7cfc04
.I *stringp
Packit 7cfc04
is NULL, the
Packit 7cfc04
.BR strsep ()
Packit 7cfc04
function returns NULL
Packit 7cfc04
and does nothing else.
Packit 7cfc04
Otherwise, this function finds the first token
Packit 7cfc04
in the string
Packit 7cfc04
.IR *stringp ,
Packit 7cfc04
that is delimited by one of the bytes in the string
Packit 7cfc04
.IR delim .
Packit 7cfc04
This token is terminated by overwriting the delimiter
Packit 7cfc04
with a null byte (\(aq\\0\(aq),
Packit 7cfc04
and
Packit 7cfc04
.I *stringp
Packit 7cfc04
is updated to point past the token.
Packit 7cfc04
In case no delimiter was found, the token is taken to be
Packit 7cfc04
the entire string
Packit 7cfc04
.IR *stringp ,
Packit 7cfc04
and
Packit 7cfc04
.I *stringp
Packit 7cfc04
is made NULL.
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
The
Packit 7cfc04
.BR strsep ()
Packit 7cfc04
function returns a pointer to the token,
Packit 7cfc04
that is, it returns the original value of
Packit 7cfc04
.IR *stringp .
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lb lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR strsep ()
Packit 7cfc04
T}	Thread safety	MT-Safe
Packit 7cfc04
.TE
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
4.4BSD.
Packit 7cfc04
.SH NOTES
Packit 7cfc04
The
Packit 7cfc04
.BR strsep ()
Packit 7cfc04
function was introduced as a replacement for
Packit 7cfc04
.BR strtok (3),
Packit 7cfc04
since the latter cannot handle empty fields.
Packit 7cfc04
However,
Packit 7cfc04
.BR strtok (3)
Packit 7cfc04
conforms to C89/C99 and hence is more portable.
Packit 7cfc04
.SH BUGS
Packit 7cfc04
Be cautious when using this function.
Packit 7cfc04
If you do use it, note that:
Packit 7cfc04
.IP * 2
Packit 7cfc04
This function modifies its first argument.
Packit 7cfc04
.IP *
Packit 7cfc04
This function cannot be used on constant strings.
Packit 7cfc04
.IP *
Packit 7cfc04
The identity of the delimiting character is lost.
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR index (3),
Packit 7cfc04
.BR memchr (3),
Packit 7cfc04
.BR rindex (3),
Packit 7cfc04
.BR strchr (3),
Packit 7cfc04
.BR string (3),
Packit 7cfc04
.BR strpbrk (3),
Packit 7cfc04
.BR strspn (3),
Packit 7cfc04
.BR strstr (3),
Packit 7cfc04
.BR strtok (3)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.