*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->Linux man pages -> wcstok (3)              



NAME    [Toc]    [Back]

       wcstok - split wide-character string into tokens

SYNOPSIS    [Toc]    [Back]

       #include <wchar.h>

       wchar_t *wcstok (wchar_t *wcs, const wchar_t *delim, wchar_t **ptr);

DESCRIPTION    [Toc]    [Back]

       The  wcstok  function  is  the  wide-character equivalent of the strtok
       function, with an added argument to make it multithread-safe. It can be
       used to split a wide-character string wcs into tokens, where a token is
       defined as a substring not containing any wide-characters from delim.

       The search starts at wcs, if wcs is not NULL, or at  *ptr,  if  wcs  is
       NULL.  First,  any  delimiter  wide-characters  are  skipped,  i.e. the
       pointer is advanced beyond any wide-characters which  occur  in	delim.
       If  the end of the wide-character string is now reached, wcstok returns
       NULL, to indicate that no tokens were found, and stores an  appropriate
       value  in  *ptr,  so  that  subsequent calls to wcstok will continue to
       return NULL. Otherwise, the wcstok function recognizes the beginning of
       a  token  and  returns a pointer to it, but before doing that, it zeroterminates
 the token by replacing the next wide-character which	occurs
       in delim with a L'\0' character, and it updates *ptr so that subsequent
       calls will continue searching after the end of recognized token.

RETURN VALUE    [Toc]    [Back]

       The wcstok function returns a pointer to the next token, or NULL if  no
       further token was found.

NOTES    [Toc]    [Back]

       The original wcs wide-character string is destructively modified during
       the operation.

EXAMPLE    [Toc]    [Back]

       The following code loops over the tokens contained in a	wide-character

       wchar_t *wcs = ...;
       wchar_t *token;
       wchar_t *state;
       for (token = wcstok(wcs, " \t\n", &state);
	    token != NULL;
	    token = wcstok(NULL, " \t\n", &state)) {

CONFORMING TO    [Toc]    [Back]

       ISO/ANSI C, UNIX98

SEE ALSO    [Toc]    [Back]

       strtok(3), wcschr(3)

GNU				  1999-07-25			     WCSTOK(3)
[ Back ]
 Similar pages
Name OS Title
wcstok Tru64 Split wide-character strings into tokens
wcstok_r Tru64 Split wide-character strings into tokens
strtok_r Tru64 Split string into tokens
strtok Tru64 Split string into tokens
mbsrtowcs NetBSD converts a multibyte character string to a wide character string (restartable)
wcsrtombs NetBSD converts a wide character string to a multibyte character string (restartable)
wcsspn Linux advance in a wide-character string, skipping any of a set of wide characters
wcspbrk Linux search a wide-character string for any of a set of wide characters
wcscspn Linux search a wide-character string for any of a set of wide characters
wcschr Linux search a wide character in a wide-character string
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service