150 lines
5.9 KiB
HTML
150 lines
5.9 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta name="generator" content="HTML Tidy, see www.w3.org">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
|
|
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
|
|
<title>wcstok</title>
|
|
</head>
|
|
<body bgcolor="white">
|
|
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
|
|
</script>
|
|
|
|
<basefont size="3"> <a name="wcstok"></a> <a name="tag_03_844"></a><!-- wcstok -->
|
|
<!--header start-->
|
|
<center><font size="2">The Open Group Base Specifications Issue 6<br>
|
|
IEEE Std 1003.1-2001<br>
|
|
Copyright © 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
|
|
|
|
<!--header end-->
|
|
<hr size="2" noshade>
|
|
<h4><a name="tag_03_844_01"></a>NAME</h4>
|
|
|
|
<blockquote>wcstok - split a wide-character string into tokens</blockquote>
|
|
|
|
<h4><a name="tag_03_844_02"></a>SYNOPSIS</h4>
|
|
|
|
<blockquote class="synopsis">
|
|
<p><code><tt>#include <<a href="../basedefs/wchar.h.html">wchar.h</a>><br>
|
|
<br>
|
|
wchar_t *wcstok(wchar_t *restrict</tt> <i>ws1</i><tt>, const wchar_t *restrict</tt> <i>ws2</i><tt>,<br>
|
|
wchar_t **restrict</tt> <i>ptr</i><tt>);<br>
|
|
</tt></code></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_844_03"></a>DESCRIPTION</h4>
|
|
|
|
<blockquote>
|
|
<div class="box"><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]"
|
|
border="0"> The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the
|
|
requirements described here and the ISO C standard is unintentional. This volume of IEEE Std 1003.1-2001 defers to
|
|
the ISO C standard. <img src="../images/opt-end.gif" alt="[Option End]" border="0"></div>
|
|
|
|
<p>A sequence of calls to <i>wcstok</i>() shall break the wide-character string pointed to by <i>ws1</i> into a sequence of tokens,
|
|
each of which shall be delimited by a wide-character code from the wide-character string pointed to by <i>ws2</i>. The <i>ptr</i>
|
|
argument points to a caller-provided <b>wchar_t</b> pointer into which the <i>wcstok</i>() function shall store information
|
|
necessary for it to continue scanning the same wide-character string.</p>
|
|
|
|
<p>The first call in the sequence has <i>ws1</i> as its first argument, and is followed by calls with a null pointer as their first
|
|
argument. The separator string pointed to by <i>ws2</i> may be different from call to call.</p>
|
|
|
|
<p>The first call in the sequence shall search the wide-character string pointed to by <i>ws1</i> for the first wide-character code
|
|
that is <i>not</i> contained in the current separator string pointed to by <i>ws2</i>. If no such wide-character code is found,
|
|
then there are no tokens in the wide-character string pointed to by <i>ws1</i> and <i>wcstok</i>() shall return a null pointer. If
|
|
such a wide-character code is found, it shall be the start of the first token.</p>
|
|
|
|
<p>The <i>wcstok</i>() function shall then search from there for a wide-character code that <i>is</i> contained in the current
|
|
separator string. If no such wide-character code is found, the current token extends to the end of the wide-character string
|
|
pointed to by <i>ws1</i>, and subsequent searches for a token shall return a null pointer. If such a wide-character code is found,
|
|
it shall be overwritten by a null wide character, which terminates the current token. The <i>wcstok</i>() function shall save a
|
|
pointer to the following wide-character code, from which the next search for a token shall start.</p>
|
|
|
|
<p>Each subsequent call, with a null pointer as the value of the first argument, shall start searching from the saved pointer and
|
|
behave as described above.</p>
|
|
|
|
<p>The implementation shall behave as if no function calls <i>wcstok</i>().</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_844_04"></a>RETURN VALUE</h4>
|
|
|
|
<blockquote>
|
|
<p>Upon successful completion, the <i>wcstok</i>() function shall return a pointer to the first wide-character code of a token.
|
|
Otherwise, if there is no token, <i>wcstok</i>() shall return a null pointer.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_844_05"></a>ERRORS</h4>
|
|
|
|
<blockquote>
|
|
<p>No errors are defined.</p>
|
|
</blockquote>
|
|
|
|
<hr>
|
|
<div class="box"><em>The following sections are informative.</em></div>
|
|
|
|
<h4><a name="tag_03_844_06"></a>EXAMPLES</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_844_07"></a>APPLICATION USAGE</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_844_08"></a>RATIONALE</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_844_09"></a>FUTURE DIRECTIONS</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_844_10"></a>SEE ALSO</h4>
|
|
|
|
<blockquote>
|
|
<p>The Base Definitions volume of IEEE Std 1003.1-2001, <a href="../basedefs/wchar.h.html"><i><wchar.h></i></a></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_844_11"></a>CHANGE HISTORY</h4>
|
|
|
|
<blockquote>
|
|
<p>First released in Issue 4.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_844_12"></a>Issue 5</h4>
|
|
|
|
<blockquote>
|
|
<p>Aligned with ISO/IEC 9899:1990/Amendment 1:1995 (E). Specifically, a third argument is added to the definition of
|
|
<i>wcstok</i>() in the SYNOPSIS.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_844_13"></a>Issue 6</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>wcstok</i>() prototype is updated for alignment with the ISO/IEC 9899:1999 standard.</p>
|
|
</blockquote>
|
|
|
|
<div class="box"><em>End of informative text.</em></div>
|
|
|
|
<hr>
|
|
<hr size="2" noshade>
|
|
<center><font size="2"><!--footer start-->
|
|
UNIX ® is a registered Trademark of The Open Group.<br>
|
|
POSIX ® is a registered Trademark of The IEEE.<br>
|
|
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
|
|
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
|
|
]</font></center>
|
|
|
|
<!--footer end-->
|
|
<hr size="2" noshade>
|
|
</body>
|
|
</html>
|
|
|