CINXE.COM
wcstok
<html> <head> <title>wcstok</title> <META NAME="KEYWORDS" CONTENT="wcstok"> </head> <body BGCOLOR="#ffffff" LINK="#0000ff" VLINK="#0000ff" ALINK="#0000ff" TEXT="#000000"> <center> <h1><b>wcstok</b></h1></center> <PRE> <STRONG><A HREF="/man3/WCSTOK">WCSTOK(3)</A></STRONG> Linux Programmer's Manual <STRONG><A HREF="/man3/WCSTOK">WCSTOK(3)</A></STRONG> NAME wcstok - split wide-character string into tokens SYNOPSIS #include <wchar.h> wchar_t *wcstok(wchar_t *wcs, const wchar_t *delim, wchar_t **ptr); DESCRIPTION The wcstok() function is the wide-character equivalent of the <STRONG><A HREF="/man3/strtok">strtok(3)</A></STRONG> 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 de- lim. The search starts at wcs, if wcs is not NULL, or at *ptr, if wcs is NULL. First, any delimiter wide-characters are skipped, that is, the pointer is advanced beyond any wide-characters which occur in delim. If the end of the wide-character string is now reached, wcstok() re- turns NULL, to indicate that no tokens were found, and stores an appro- priate value in *ptr, so that subsequent calls to wcstok() will con- tinue to return NULL. Otherwise, the wcstok() function recognizes the beginning of a token and returns a pointer to it, but before doing that, it zero-terminates the token by replacing the next wide-character which occurs in delim with a null wide character (L'\0'), and it up- dates *ptr so that subsequent calls will continue searching after the end of recognized token. RETURN VALUE The wcstok() function returns a pointer to the next token, or NULL if no further token was found. ATTRIBUTES For an explanation of the terms used in this section, see at- <STRONG><A HREF="/man7/tributes">tributes(7)</A></STRONG>. +----------+---------------+---------+ |Interface | Attribute | Value | +----------+---------------+---------+ |wcstok() | Thread safety | MT-Safe | +----------+---------------+---------+ CONFORMING TO POSIX.1-2001, POSIX.1-2008, C99. NOTES The original wcs wide-character string is destructively modified during the operation. EXAMPLE The following code loops over the tokens contained in a wide-character string. wchar_t *wcs = ...; wchar_t *token; wchar_t *state; for (token = wcstok(wcs, " \t\n", &state); token != NULL; token = wcstok(NULL, " \t\n", &state)) { ... } SEE ALSO <STRONG><A HREF="/man3/strtok">strtok(3)</A></STRONG>, <STRONG><A HREF="/man3/wcschr">wcschr(3)</A></STRONG> COLOPHON This page is part of release 5.05 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at https://www.kernel.org/doc/man-pages/. GNU 2019-03-06 <STRONG><A HREF="/man3/WCSTOK">WCSTOK(3)</A></STRONG></PRE> <center> <h6>Man Pages Copyright Respective Owners. Site Copyright (C) 1994 - 2025 <a href="http://www.he.net">Hurricane Electric</a>. All Rights Reserved.</h6></center> </body> </html>