wcstok | Programming Place Plus　Ｃ言語編　標準ライブラリのリファレンス

概要

ワイド文字列を分割する。

ヘッダ

wchar.h

形式

wchar_t* wcstok(wchar_t* restrict str, const wchar_t* restrict set, wchar_t** restrict ptr);

引数

str

対象のワイド文字列。２回目以降の呼び出し時には、ヌルポインタを指定。

set

区切り文字を書き並べたワイド文字列。

ptr

関数が内部で作業用に使うポインタ変数を呼び出し側で用意し、それを指すポインタを与える。

戻り値

分割して得られた文字の並びを指すポインタを返す。文字の並びが得られなかった場合は、ヌルポインタが返される。

詳細

まず前提として、この関数は何度も繰り返し呼び出すような使い方をすることを理解しておくこと。
この関数の目的は、あるワイド文字列を、特定の区切り文字ごとに分割することである。たとえば、L”abc,defgh,ij” という文字列に対し、区切り文字を L”,” として与えれば、L”abc”、L”defgh”、L”ij” を得られる。
１度目の呼び出しの際にだけ、引数str に対象となるワイド文字列を指定する。２度目以降は、前回の続きから調べるということを表すために引数str をヌルポインタとする。したがって、１度目と、２度目以降とでは、引数str に与えるべき値は異なる。引数set に関しては、その必要があれば呼び出しごとに異なっても構わない。
引数set に含まれる各ワイド文字がそれぞれ区切り文字の候補である。たとえば L”.,” を与えたとすれば、L’.’ でも L’,’ でも区切り文字とみなされる。
マルチバイト文字列版の strtok関数とは異なり、作業用の変数は関数内部ではなく、外部で用意して与える仕様になっている。したがって、同時に２つの異なるワイド文字列を対象として、並列的に関数を呼び出しても、異なる作業用変数を与えていれば問題なく動作する。

注意

使用例

#include <stdio.h>
#include <wchar.h>
#include <locale.h>

int main(void)
{
    wchar_t str[] = L"abc,defhi,jk";
    const wchar_t* const separator = L",";

    setlocale(LC_CTYPE, "");

    wchar_t* work;
    wchar_t* token = wcstok(str, separator, &work);
    while (token != NULL) {
        wprintf(L"%ls\n", token);
        token = wcstok(NULL, separator, &work);
    }

    wprintf(L"\n");
    wprintf(L"元の文字列が直接書き換えられていることを確認\n");
    wprintf(L"%ls\n", str);
}

実行結果：

abc
defgh
ij

元の文字列が直接書き換えられていることを確認
abc

関連

マルチバイト文字列版の strtok関数がある。ただし、wcstok関数にある３個目の引数がなく、並列的な呼び出しに問題がある。

解説章