2.11BSD/src/man/man3/strtok.3

.\" Copyright (c) 1988, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the American National Standards Committee X3, on Information
.\" Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)strtok.3	8.2.1 (2.11BSD) 1996/1/12
.\"
.TH STRTOK 3 "January 12, 1996"
.UC 7
.SH NAME
\fBstrtok\fP \- string tokens
.SH SYNOPSIS
.B #include <string.h>
.sp
.B char *
.br
\fBstrtok\fP(str, sep)
.br
.I char *str;
.br
.I char *sep;
.SH DESCRIPTION
.B This interface is obsoleted by strsep(3).
.PP
The
.BR strtok ()
function
is used to isolate sequential tokens in a null-terminated string,
.I str .
These tokens are separated in the string by at least one of the
characters in
.I sep .
The first time that
.BR strtok ()
is called,
.I str
should be specified; subsequent calls, wishing to obtain further tokens
from the same string, should pass a null pointer instead.
The separator string,
.I sep ,
must be supplied each time, and may change between calls.
.PP
The
.BR strtok ()
function
returns a pointer to the beginning of each subsequent token in the string,
after replacing the token itself with a
.B NUL
character.
When no more tokens remain, a null pointer is returned.
.SH SEE ALSO
index(3),
memchr(3),
rindex(3),
strchr(3),
strcspn(3),
strpbrk(3),
strrchr(3),
strsep(3),
strspn(3),
strstr(3
.SH STANDARDS
The
.BR strtok ()
function
conforms to
ANSI C X3.159-1989 (``ANSI C'').
.SH BUGS
There is no way to get tokens from multiple strings simultaneously.
.PP
The System V
.BR strtok (),
if handed a string containing only delimiter characters,
will not alter the next starting point, so that a call to
.BR strtok ()
with a different (or empty) delimiter string
may return a
non-\fBNULL\fP
value.
Since this implementation always alters the next starting point,
such a sequence of calls would always return
.BR NULL .