2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
|
|
|
|
|
.\"
|
|
|
|
|
.\" This is free documentation; you can redistribute it and/or
|
|
|
|
|
.\" modify it under the terms of the GNU General Public License as
|
|
|
|
|
.\" published by the Free Software Foundation; either version 2 of
|
|
|
|
|
.\" the License, or (at your option) any later version.
|
|
|
|
|
.\"
|
|
|
|
|
.\" References consulted:
|
|
|
|
|
.\" GNU glibc-2 source code and manual
|
|
|
|
|
.\" Dinkumware C library reference http://www.dinkumware.com/
|
intro.1, time.1, accept.2, bind.2, connect.2, execve.2, flock.2, getdents.2, getpriority.2, getuid.2, intro.2, ioctl.2, mincore.2, mknod.2, personality.2, ptrace.2, read.2, recv.2, select_tut.2, send.2, sendfile.2, shmctl.2, sigaction.2, signal.2, stat.2, times.2, truncate.2, umask.2, wait.2, MB_CUR_MAX.3, MB_LEN_MAX.3, argz_add.3, btowc.3, clearenv.3, clock.3, cmsg.3, end.3, endian.3, errno.3, exit.3, fgetwc.3, fgetws.3, fopen.3, fputwc.3, fputws.3, fseek.3, fwide.3, getfsent.3, getgrnam.3, gethostid.3, getipnodebyname.3, getmntent.3, getpwnam.3, getwchar.3, grantpt.3, iconv.3, iconv_close.3, iconv_open.3, insque.3, intro.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mkstemp.3, mktemp.3, nl_langinfo.3, openpty.3, posix_openpt.3, printf.3, ptsname.3, putwchar.3, qecvt.3, rcmd.3, readdir.3, rexec.3, rpc.3, setnetgrent.3, shm_open.3, sigpause.3, stdin.3, stpcpy.3, strftime.3, strptime.3, syslog.3, towctrans.3, towlower.3, towupper.3, ttyslot.3, ungetwc.3, unlocked_stdio.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wprintf.3, console_ioctl.4, pts.4, elf.5, filesystems.5, hosts.5, proc.5, ttytype.5, boot.7, capabilities.7, credentials.7, epoll.7, glob.7, koi8-r.7, path_resolution.7, pty.7, signal.7, suffixes.7, time.7, unicode.7, unix.7, uri.7, utf-8.7: global fix: s/Unix/UNIX/
The man pages were rather inconsistent in the use of "Unix"
versus "UNIX". Let's go with the trademark usage.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-12 04:45:38 +00:00
|
|
|
.\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" ISO/IEC 9899:1999
|
|
|
|
|
.\"
|
fgetws.3, fputws.3, mbrtowc.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscat.3, wcscpy.3, wcslen.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcsrtombs.3, wcsstr.3, wcstok.3, wcstombs.3, wcwidth.3: Global fix: consistent use of "null wide character"
Bring more consistency to the discussion of
"[terminating] null wide character"
by writing (at least in the initial use in a page)
"[terminating] null wide character (L'\0')".
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2011-09-28 03:46:39 +00:00
|
|
|
.TH WCSTOK 3 2011-09-28 "GNU" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
|
wcstok \- split wide-character string into tokens
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
.B #include <wchar.h>
|
|
|
|
|
.sp
|
2008-07-06 15:10:32 +00:00
|
|
|
.BI "wchar_t *wcstok(wchar_t *" wcs ", const wchar_t *" delim \
|
|
|
|
|
", wchar_t **" ptr );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
|
.BR wcstok ()
|
|
|
|
|
function is the wide-character equivalent of the
|
|
|
|
|
.BR strtok (3)
|
|
|
|
|
function,
|
2007-04-12 22:42:49 +00:00
|
|
|
with an added argument to make it multithread-safe.
|
2006-12-27 03:54:41 +00:00
|
|
|
It can be used
|
2004-11-03 13:51:07 +00:00
|
|
|
to split a wide-character string \fIwcs\fP into tokens, where a token is
|
|
|
|
|
defined as a substring not containing any wide-characters from \fIdelim\fP.
|
|
|
|
|
.PP
|
2007-04-24 16:44:51 +00:00
|
|
|
The search starts at \fIwcs\fP, if \fIwcs\fP is not NULL,
|
|
|
|
|
or at \fI*ptr\fP, if \fIwcs\fP is NULL.
|
2007-06-08 11:56:22 +00:00
|
|
|
First, any delimiter wide-characters are skipped, that is, the
|
2004-11-03 13:51:07 +00:00
|
|
|
pointer is advanced beyond any wide-characters which occur in \fIdelim\fP.
|
2007-04-24 16:44:51 +00:00
|
|
|
If the end of the wide-character string is now
|
2007-05-12 09:06:04 +00:00
|
|
|
reached,
|
|
|
|
|
.BR wcstok ()
|
|
|
|
|
returns NULL, to indicate that no tokens
|
2007-04-24 16:44:51 +00:00
|
|
|
were found, and stores an appropriate value in \fI*ptr\fP,
|
2007-05-12 09:06:04 +00:00
|
|
|
so that subsequent calls to
|
|
|
|
|
.BR wcstok ()
|
|
|
|
|
will continue to return NULL.
|
|
|
|
|
Otherwise, the
|
|
|
|
|
.BR wcstok ()
|
|
|
|
|
function recognizes the beginning of a token
|
2004-11-03 13:51:07 +00:00
|
|
|
and returns a pointer to it, but before doing that, it zero-terminates the
|
|
|
|
|
token by replacing the next wide-character which occurs in \fIdelim\fP with
|
fgetws.3, fputws.3, mbrtowc.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscat.3, wcscpy.3, wcslen.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcsrtombs.3, wcsstr.3, wcstok.3, wcstombs.3, wcwidth.3: Global fix: consistent use of "null wide character"
Bring more consistency to the discussion of
"[terminating] null wide character"
by writing (at least in the initial use in a page)
"[terminating] null wide character (L'\0')".
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2011-09-28 03:46:39 +00:00
|
|
|
a null wide character (L\(aq\\0\(aq),
|
2008-06-09 15:49:35 +00:00
|
|
|
and it updates \fI*ptr\fP so that subsequent calls will
|
2004-11-03 13:51:07 +00:00
|
|
|
continue searching after the end of recognized token.
|
|
|
|
|
.SH "RETURN VALUE"
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
|
.BR wcstok ()
|
|
|
|
|
function returns a pointer to the next token,
|
2007-04-24 16:44:51 +00:00
|
|
|
or NULL if no further token was found.
|
2007-05-19 04:30:20 +00:00
|
|
|
.SH "CONFORMING TO"
|
|
|
|
|
C99.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NOTES
|
|
|
|
|
The original \fIwcs\fP wide-character string is destructively modified during
|
|
|
|
|
the operation.
|
|
|
|
|
.SH EXAMPLE
|
|
|
|
|
The following code loops over the tokens contained in a wide-character string.
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
wchar_t *wcs = ...;
|
|
|
|
|
wchar_t *token;
|
|
|
|
|
wchar_t *state;
|
|
|
|
|
for (token = wcstok(wcs, " \\t\\n", &state);
|
2007-04-03 15:32:52 +00:00
|
|
|
token != NULL;
|
|
|
|
|
token = wcstok(NULL, " \\t\\n", &state)) {
|
|
|
|
|
...
|
2004-11-03 13:51:07 +00:00
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR strtok (3),
|
|
|
|
|
.BR wcschr (3)
|