180 lines
4.2 KiB
HTML
180 lines
4.2 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of WCSTOK</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>WCSTOK</H1>
|
|
Section: Linux Programmer's Manual (3)<BR>Updated: 2019-03-06<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
wcstok - split wide-character string into tokens
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<PRE>
|
|
<B>#include <<A HREF="file:///usr/include/wchar.h">wchar.h</A>></B>
|
|
|
|
<B>wchar_t *wcstok(wchar_t *</B><I>wcs</I><B>, const wchar_t *</B><I>delim</I><B>, wchar_t **</B><I>ptr</I><B>);</B>
|
|
</PRE>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The
|
|
<B>wcstok</B>()
|
|
|
|
function is the wide-character equivalent of the
|
|
<B><A HREF="/cgi-bin/man/man2html?3+strtok">strtok</A></B>(3)
|
|
|
|
function,
|
|
with an added argument to make it multithread-safe.
|
|
It can be used
|
|
to split a wide-character string
|
|
<I>wcs</I>
|
|
|
|
into tokens, where a token is
|
|
defined as a substring not containing any wide-characters from
|
|
<I>delim</I>.
|
|
|
|
<P>
|
|
|
|
The search starts at
|
|
<I>wcs</I>,
|
|
|
|
if
|
|
<I>wcs</I>
|
|
|
|
is not NULL,
|
|
or at
|
|
<I>*ptr</I>,
|
|
|
|
if
|
|
<I>wcs</I>
|
|
|
|
is NULL.
|
|
First, any delimiter wide-characters are skipped, that is, the
|
|
pointer is advanced beyond any wide-characters which occur in
|
|
<I>delim</I>.
|
|
|
|
If the end of the wide-character string is now
|
|
reached,
|
|
<B>wcstok</B>()
|
|
|
|
returns NULL, to indicate that no tokens
|
|
were found, and stores an appropriate value in
|
|
<I>*ptr</I>,
|
|
|
|
so that subsequent calls to
|
|
<B>wcstok</B>()
|
|
|
|
will continue to return NULL.
|
|
Otherwise, the
|
|
<B>wcstok</B>()
|
|
|
|
function recognizes the beginning of a token
|
|
and returns a pointer to it, but before doing that, it zero-terminates the
|
|
token by replacing the next wide-character which occurs in
|
|
<I>delim</I>
|
|
|
|
with
|
|
a null wide character (L'\0'),
|
|
and it updates
|
|
<I>*ptr</I>
|
|
|
|
so that subsequent calls will
|
|
continue searching after the end of recognized token.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>RETURN VALUE</H2>
|
|
|
|
The
|
|
<B>wcstok</B>()
|
|
|
|
function returns a pointer to the next token,
|
|
or NULL if no further token was found.
|
|
<A NAME="lbAF"> </A>
|
|
<H2>ATTRIBUTES</H2>
|
|
|
|
For an explanation of the terms used in this section, see
|
|
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
|
|
|
|
<TABLE BORDER>
|
|
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
|
|
<TR VALIGN=top><TD>
|
|
<B>wcstok</B>()
|
|
|
|
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
|
|
</TABLE>
|
|
|
|
<A NAME="lbAG"> </A>
|
|
<H2>CONFORMING TO</H2>
|
|
|
|
POSIX.1-2001, POSIX.1-2008, C99.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>NOTES</H2>
|
|
|
|
The original
|
|
<I>wcs</I>
|
|
|
|
wide-character string is destructively modified during
|
|
the operation.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>EXAMPLE</H2>
|
|
|
|
The following code loops over the tokens contained in a wide-character string.
|
|
<P>
|
|
|
|
|
|
wchar_t *wcs = ...;
|
|
wchar_t *token;
|
|
wchar_t *state;
|
|
for (token = wcstok(wcs, " \t\n", &state);
|
|
<BR> token != NULL;
|
|
<BR> token = wcstok(NULL, " \t\n", &state)) {
|
|
<BR> ...
|
|
}
|
|
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+strtok">strtok</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+wcschr">wcschr</A></B>(3)
|
|
|
|
<A NAME="lbAK"> </A>
|
|
<H2>COLOPHON</H2>
|
|
|
|
This page is part of release 5.05 of the Linux
|
|
<I>man-pages</I>
|
|
|
|
project.
|
|
A description of the project,
|
|
information about reporting bugs,
|
|
and the latest version of this page,
|
|
can be found at
|
|
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="4"><A HREF="#lbAE">RETURN VALUE</A><DD>
|
|
<DT id="5"><A HREF="#lbAF">ATTRIBUTES</A><DD>
|
|
<DT id="6"><A HREF="#lbAG">CONFORMING TO</A><DD>
|
|
<DT id="7"><A HREF="#lbAH">NOTES</A><DD>
|
|
<DT id="8"><A HREF="#lbAI">EXAMPLE</A><DD>
|
|
<DT id="9"><A HREF="#lbAJ">SEE ALSO</A><DD>
|
|
<DT id="10"><A HREF="#lbAK">COLOPHON</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:59 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|