WCSTOK(3)

NAME
wcstok - get next token from a string

SYNOPSIS

#include <wchar.h>

wchar_t *wcstok(wchar_t *__restrict source, const wchar_t *__restrict delimiters, wchar_t **__restrict lasts);

DESCRIPTION

The wcstok function is the wide-character equivalent of the strtok_r function (which in turn is the same as the strtok function with an added argument to make it thread-safe).

The wcstok function is used to isolate (one at a time) sequential tokens in a null-terminated wide-character string, *source. A token is defined as a substring not containing any wide-characters from *delimiters.

The first time that wcstok is called, *source should be specified with the wide-character string to be searched, and *lasts--but not lasts, which must be non-NULL--may be random; subsequent calls, wishing to obtain further tokens from the same string, should pass a null pointer for *source instead but must supply *lasts unchanged from the last call. The separator wide-character string, *delimiters, must be supplied each time and may change between calls. A pointer to placeholder *lasts must be supplied by the caller, and is set each time as needed to save the state by wcstok. Every call to wcstok with *source == NULL must pass the value of *lasts as last set by wcstok.

The wcstok function returns a pointer to the beginning of each subsequent token in the string, after replacing the separator wide-character itself with a null wide-character. When no more tokens remain, a null pointer is returned.

RETURNS

wcstok returns a pointer to the first wide character of a token, or NULL if there is no token.

NOTES

wcstok is thread-safe (unlike strtok, but like strtok_r). wcstok writes into the string being searched.

PORTABILITY

wcstok is C99 and POSIX.1-2001.

wcstok requires no supporting OS subroutines.

AUTHORS

Steve Chamberlain
    Author.

Roland Pesch
    Author.

Red Hat Support

Jeff Johnston
    Author.

COPYRIGHT

This file documents the ANSI C library.

Copyright (C) 1992, 1993, 1994-2014 Red Hat, Inc.

libc includes software developed by the University of California, Berkeley and its contributors.

libc includes software developed by Martin Jackson, Graham Haley and Steve Chamberlain of Tadpole Technology and released to Cygnus.

libc uses floating-point conversion software developed at AT&T, which includes this copyright information:

The author of this software is David M. Gay.

Copyright (c) 1991 by AT&T.

Permission to use, copy, modify, and distribute this software for any purpose without fee is hereby granted, provided that this entire notice is included in all copies of any software which is or includes a copy or modification of this software and in all copies of the supporting documentation for such software.

THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED WARRANTY. IN PARTICULAR, NEITHER THE AUTHOR NOR AT&T MAKES ANY REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE.

Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.

Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, subject to the terms of the GNU General Public License, which includes the provision that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.

Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions.