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

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



NAME    [Toc]    [Back]

     wcstok -- split wide-character string into tokens

LIBRARY    [Toc]    [Back]

     Standard C Library (libc, -lc)

SYNOPSIS    [Toc]    [Back]

     #include <wchar.h>

     wchar_t *
     wcstok(wchar_t * restrict str, const wchar_t * restrict sep,
	 wchar_t ** restrict last);

DESCRIPTION    [Toc]    [Back]

     The wcstok() function is used to isolate sequential tokens in a null-terminated
 wide character string, str.  These tokens are separated in the
     string by at least one of the characters in sep.  The first time that
     wcstok() is called, str should be specified; subsequent calls, wishing to
     obtain further tokens from the same string, should pass a null pointer
     instead.  The separator string, sep, must be supplied each time, and may
     change between calls.  The context pointer last must be provided on each

     The wcstok() function is the wide character counterpart of the strtok_r()

RETURN VALUES    [Toc]    [Back]

     The wcstok() function returns a pointer to the beginning of each subsequent
 token in the string, after replacing the token itself with a null
     wide character (L'\0').  When no more tokens remain, a null pointer is

EXAMPLES    [Toc]    [Back]

     The following code fragment splits a wide character string on ASCII
     space, tab and newline characters and writes the tokens to standard output:

	   const wchar_t *seps = L" \t\n";
	   wchar_t *last, *tok, text[] = L" \none\ttwo\t\tthree  \n";

	   for (tok = wcstok(text, seps, &last); tok != NULL;
	       tok = wcstok(NULL, seps, &last))
		   wprintf(L"%ls\n", tok);

COMPATIBILITY    [Toc]    [Back]

     Some early implementations of wcstok() omit the context pointer argument,
     last, and maintain state across calls in a static variable like strtok()

SEE ALSO    [Toc]    [Back]

     strtok(3), wcschr(3), wcscspn(3), wcspbrk(3), wcsrchr(3), wcsspn(3)

STANDARDS    [Toc]    [Back]

     The wcstok() function conforms to ISO/IEC 9899:1999 (``ISO C99'').

FreeBSD 5.2.1			October 3, 2002 		 FreeBSD 5.2.1
[ 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