WCSTOK(3POSIX)

💖 WCSTOK(3POSIX) 💖

okay bestie, welcome to the POSIX Programmer's Manual ✨ this one's WCSTOK(3POSIX), and it's all about splitting wide-character strings into lil tokens. sit down, grab a strawberry 🍓, let's go.

---

🌸 PROLOG 🌸

so real talk first: this manual page is part of the POSIX Programmer's Manual. the Linux implementation of this interface may differ (like, go check the corresponding Linux manual page for the deets on Linux behavior, fr), or honestly the interface may not even be implemented on Linux. 💀

---

✨ NAME ✨

wcstok — split a wide-character string into tokens 👑

---

🎀 SYNOPSIS 🎀

#include <wchar.h>

wchar_t *wcstok(wchar_t *restrict ws1, const wchar_t *restrict ws2,
    wchar_t **restrict ptr);

---

🦋 DESCRIPTION 🦋

the functionality described on this reference page is aligned with the ISO C standard. any conflict between the requirements described here and the ISO C standard is unintentional — no drama intended. this volume of POSIX.1‐2017 defers to the ISO C standard. periodt.

a sequence of calls to wcstok() shall break the wide-character string pointed to by ws1 into a sequence of tokens, and each of those tokens shall be delimited by a wide-character code from the wide-character string pointed to by ws2. the ptr argument points to a caller-provided wchar_t pointer, and that's where wcstok() shall store the info it needs to keep scanning the same wide-character string. it's giving bookmark energy, honestly. 🔖

the first call in the sequence has ws1 as its first argument, and then it's followed by calls with a null pointer as their first argument. and the separator string pointed to by ws2? it may be different from call to call. no commitment, iconic behavior. 💅

the first call in the sequence shall search the wide-character string pointed to by ws1 for the first wide-character code that is not contained in the current separator string pointed to by ws2. if no such wide-character code is found, then there are no tokens in the wide-character string pointed to by ws1 and wcstok() shall return a null pointer. if such a wide-character code is found, it shall be the start of the first token. 🫶

then the wcstok() function shall search from there for a wide-character code that is contained in the current separator string. if no such wide-character code is found, the current token extends to the end of the wide-character string pointed to by ws1, and subsequent searches for a token shall return a null pointer. if such a wide-character code is found, it shall be overwritten by a null wide character, which terminates the current token. then wcstok() shall save a pointer to the following wide-character code, and that's where the next search for a token shall start. main character move. 🌟

each subsequent call, with a null pointer as the value of the first argument, shall start searching from the saved pointer and behave as described above. same vibe, new search. ✨

the implementation shall behave as if no function calls wcstok().

---

💜 RETURN VALUE 💜

upon successful completion, the wcstok() function shall return a pointer to the first wide-character code of a token. otherwise, if there is no token, wcstok() shall return a null pointer. so like, no token = nothing to show, sorry babe. 😭

---

🌈 ERRORS 🌈

no errors are defined. we love a low-maintenance function. 🙈

the following sections are informative. (yes bestie, informative, not normative — noted.)

---

🍓 EXAMPLES 🍓

none. 😌

---

🧚 APPLICATION USAGE 🧚

none. 💖

---

⭐ RATIONALE ⭐

none. 💅

---

👑 FUTURE DIRECTIONS 👑

none. 🔥

---

🌸 SEE ALSO 🌸

• the Base Definitions volume of POSIX.1‐2017, <wchar.h>

---

💖 COPYRIGHT 💖

portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. in the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. the original Standard can be obtained online at http://www.opengroup.org/unix/online.html .

any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. to report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .

---

ngl bestie, that's the whole page — every option, every null pointer, every vibe, all intact. no cap. 🫶

and that's a wrap from IEEE/The Open Group, 2017 ✨ mwah, go split some wide-character strings responsibly 💅🎀