original/man3/wcstok.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" References consulted:
   9 .\"   GNU glibc-2 source code and manual
  10 .\"   Dinkumware C library reference http://www.dinkumware.com/
  11 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  12 .\"   ISO/IEC 9899:1999
  13 .\"
  14 .TH WCSTOK 3  2011-09-28 "GNU" "Linux Programmer's Manual"
  15 .SH NAME
  16 wcstok \- split wide-character string into tokens
  17 .SH SYNOPSIS
  18 .nf
  19 .B #include <wchar.h>
  20 .sp
  21 .BI "wchar_t *wcstok(wchar_t *" wcs ", const wchar_t *" delim \
  22 ", wchar_t **" ptr );
  23 .fi
  24 .SH DESCRIPTION
  25 The
  26 .BR wcstok ()
  27 function is the wide-character equivalent of the
  28 .BR strtok (3)
  29 function,
  30 with an added argument to make it multithread-safe.
  31 It can be used
  32 to split a wide-character string \fIwcs\fP into tokens, where a token is
  33 defined as a substring not containing any wide-characters from \fIdelim\fP.
  34 .PP
  35 The search starts at \fIwcs\fP, if \fIwcs\fP is not NULL,
  36 or at \fI*ptr\fP, if \fIwcs\fP is NULL.
  37 First, any delimiter wide-characters are skipped, that is, the
  38 pointer is advanced beyond any wide-characters which occur in \fIdelim\fP.
  39 If the end of the wide-character string is now
  40 reached,
  41 .BR wcstok ()
  42 returns NULL, to indicate that no tokens
  43 were found, and stores an appropriate value in \fI*ptr\fP,
  44 so that subsequent calls to
  45 .BR wcstok ()
  46 will continue to return NULL.
  47 Otherwise, the
  48 .BR wcstok ()
  49 function recognizes the beginning of a token
  50 and returns a pointer to it, but before doing that, it zero-terminates the
  51 token by replacing the next wide-character which occurs in \fIdelim\fP with
  52 a null wide character (L\(aq\\0\(aq),
  53 and it updates \fI*ptr\fP so that subsequent calls will
  54 continue searching after the end of recognized token.
  55 .SH "RETURN VALUE"
  56 The
  57 .BR wcstok ()
  58 function returns a pointer to the next token,
  59 or NULL if no further token was found.
  60 .SH "CONFORMING TO"
  61 C99.
  62 .SH NOTES
  63 The original \fIwcs\fP wide-character string is destructively modified during
  64 the operation.
  65 .SH EXAMPLE
  66 The following code loops over the tokens contained in a wide-character string.
  67 .sp
  68 .nf
  69 wchar_t *wcs = ...;
  70 wchar_t *token;
  71 wchar_t *state;
  72 for (token = wcstok(wcs, " \\t\\n", &state);
  73     token != NULL;
  74     token = wcstok(NULL, " \\t\\n", &state)) {
  75     ...
  76 }
  77 .fi
  78 .SH "SEE ALSO"
  79 .BR strtok (3),
  80 .BR wcschr (3)