OSDN Git Service

(split) LDP: Restore and add Copyrights for draft pages
[linuxjm/LDP_man-pages.git] / draft / man3 / wcstok.3
index 3379194..9a85a6a 100644 (file)
 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
 .\"
+.\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
 .\" 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.
+.\" %%%LICENSE_END
 .\"
 .\" References consulted:
 .\"   GNU glibc-2 source code and manual
 .\"   Dinkumware C library reference http://www.dinkumware.com/
-.\"   OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
+.\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
 .\"   ISO/IEC 9899:1999
 .\"
-.\" About this Japanese page, please contact to JM Project <JM@linux.or.jp>
+.\"*******************************************************************
+.\"
+.\" This file was generated with po4a. Translate the source file.
+.\"
+.\"*******************************************************************
+.\"
 .\" Translated Sat Oct 23 17:53:50 JST 1999
 .\"           by FUJIWARA Teruyoshi <fujiwara@linux.or.jp>
 .\"
-.TH WCSTOK 3 1999-07-25 "GNU" "Linux Programmer's Manual"
-.\"O .SH NAME
-.SH Ì¾Á°
-.\"O wcstok \- split wide-character string into tokens
-wcstok \- ¥ï¥¤¥Éʸ»úʸ»úÎó¤ò¥È¡¼¥¯¥ó¤Ëʬ³ä¤¹¤ë
-.\"O .SH SYNOPSIS
-.SH ½ñ¼°
+.TH WCSTOK 3 2011\-09\-28 GNU "Linux Programmer's Manual"
+.SH 名前
+wcstok \- ワイド文字文字列をトークンに分割する
+.SH 書式
 .nf
-.B #include <wchar.h>
+\fB#include <wchar.h>\fP
 .sp
-.BI "wchar_t *wcstok(wchar_t *" wcs ", const wchar_t *" delim \
-", wchar_t **" ptr );
+\fBwchar_t *wcstok(wchar_t *\fP\fIwcs\fP\fB, const wchar_t *\fP\fIdelim\fP\fB, wchar_t **\fP\fIptr\fP\fB);\fP
 .fi
-.\"O .SH DESCRIPTION
-.SH ÀâÌÀ
-.\"O The
-.\"O .BR wcstok ()
-.\"O function is the wide-character equivalent of the
-.\"O .BR strtok (3)
-.\"O function,
-.\"O with an added argument to make it multithread-safe. It can be used
-.\"O to split a wide-character string \fIwcs\fP into tokens, where a token is
-.\"O defined as a substring not containing any wide-characters from \fIdelim\fP.
-.BR wcstok ()
-´Ø¿ô¤Ï¡¢
-.BR strtok (3)
-´Ø¿ô¤ËÂбþ¤¹¤ë¥ï¥¤¥Éʸ»ú´Ø¿ô¤Ë¡¢
-¥Þ¥ë¥Á¥¹¥ì¥Ã¥É¥»¡¼¥Õ¤ÎÆ°ºî¤ò¤µ¤»¤ë¤¿¤á¤Î°ú¤­¿ô¤òÄɲä·¤¿¤â¤Î¤Ç¤¢¤ë¡£
-¤³¤Î´Ø¿ô¤òÍѤ¤¤Æ¡¢¥ï¥¤¥Éʸ»úʸ»úÎó \fIwcs\fP ¤ò¥È¡¼¥¯¥ó¤Ëʬ²ò¤¹¤ë¤³¤È
-¤¬¤Ç¤­¤ë¡£¤³¤³¤Ç¡¢¥È¡¼¥¯¥ó¤Ï \fIdelim\fP ¤ËÎóµó¤µ¤ì¤Æ¤¤¤ëʸ»ú¤ò´Þ¤Þ¤Ê
-¤¤Éôʬʸ»úÎó¤È¤·¤ÆÄêµÁ¤µ¤ì¤ë¡£
+.SH 説明
+\fBwcstok\fP()  関数は、 \fBstrtok\fP(3)  関数に対応するワイド文字関数に、
+マルチスレッドセーフの動作をさせるための引き数を追加したものである。 この関数を用いて、ワイド文字文字列 \fIwcs\fP をトークンに分解すること
+ができる。ここで、トークンは \fIdelim\fP に列挙されている文字を含まな い部分文字列として定義される。
 .PP
-.\"O The search starts at \fIwcs\fP, if \fIwcs\fP is not NULL,
-.\"O or at \fI*ptr\fP, if \fIwcs\fP is NULL.
-.\"O First, any delimiter wide-characters are skipped, that is, the
-.\"O pointer is advanced beyond any wide-characters which occur in \fIdelim\fP.
-¸¡º÷¤Ï \fIwcs\fP ¤¬ NULL ¤Ç¤Ê¤±¤ì¤Ð \fIwcs\fP ¤«¤é³«»Ï¤µ¤ì¡¢\fIwcs\fP
-¤¬ NULL ¤Ê¤é¤Ð \fI*ptr\fP ¤«¤é³«»Ï¤µ¤ì¤ë¡£¤Þ¤º¡¢Á´¤Æ¤Î¶èÀÚ¤ê¥ï¥¤¥Éʸ»ú
-¤¬¥¹¥­¥Ã¥×¤µ¤ì¤ë¡£¤Ä¤Þ¤ê¡¢\fIdelim\fP ¤Ë´Þ¤Þ¤ì¤ë¥ï¥¤¥Éʸ»ú¤òĶ¤¨¤ë¤è¤¦
-¤Ë¥Ý¥¤¥ó¥¿¤¬Á°¤Ë¿Ê¤á¤é¤ì¤ë¡£
-.\"O If the end of the wide-character string is now reached,
-.\"O .BR wcstok ()
-.\"O returns NULL, to indicate that no tokens
-.\"O were found, and stores an appropriate value in \fI*ptr\fP,
-.\"O so that subsequent calls to
-.\"O .BR wcstok ()
-.\"O will continue to return NULL.
-.\"O Otherwise, the
-.\"O .BR wcstok ()
-.\"O function recognizes the beginning of a token
-.\"O and returns a pointer to it, but before doing that, it zero-terminates the
-.\"O token by replacing the next wide-character which occurs in \fIdelim\fP with
-.\"O a L\(aq\\0\(aq character,
-.\"O and it updates \fI*ptr\fP so that subsequent calls will
-.\"O continue searching after the end of recognized token.
-¥ï¥¤¥Éʸ»úʸ»úÎó¤Î½ª¤ï¤ê¤Ë㤷¤¿¤é¡¢
-.BR wcstok ()
-¤Ï NULL ¤òÊÖ¤·¤Æ
-¥È¡¼¥¯¥ó¤¬Á´¤¯¸«¤Ä¤«¤é¤Ê¤«¤Ã¤¿¤³¤È¤ò¼¨¤·¡¢¤³¤Î¸å¤Ë
-.BR wcstok ()
-¤ò¸Æ¤Ó
-½Ð¤·¤Æ¤â NULL ¤¬ÊÖ¤µ¤ì¤ë¤è¤¦¤Ë \fI*ptr\fP ¤ËŬÀÚ¤ÊÃͤòÀßÄꤹ¤ë¡£¤½¤ì
-°Ê³°¤Î¾ì¹ç¤Ë¤Ï¡¢
-.BR wcstok ()
-´Ø¿ô¤Ï¥È¡¼¥¯¥ó¤ÎÀèƬ¤ò¼±Ê̤·¡¢¤³¤ì¤ò»Ø¤¹
-¥Ý¥¤¥ó¥¿¤òÊÖ¤¹¡£¤¿¤À¤·¤³¤ì¤ò¹Ô¤¦Á°¤Ë¡¢¥È¡¼¥¯¥ó¤Î¸å¤Ë¤¢¤ë¡¢\fIdelim\fP
-¤Ë´Þ¤Þ¤ì¤Æ¤¤¤ëʸ»ú¤ò L\(aq\\0\(aq ¤ËÃÖ¤­´¹¤¨¤ë¤³¤È¤Ë¤è¤Ã¤Æ¥È¡¼¥¯¥ó¤ò 0 ¤Ç
-½ªÃ¼¤µ¤»¤ë¡£¤µ¤é¤Ë \fI*ptr\fP ¤ò¹¹¿·¤·¡¢¸å¤Ç
-.BR wcstok ()
-¤ò¸Æ¤Ó½Ð¤·¤¿
-ºÝ¤Ë¡¢¼±Ê̤µ¤ì¤¿¥È¡¼¥¯¥ó¤Î³¤­¤«¤é¸¡º÷¤Ç¤­¤ë¤è¤¦¤Ë¤¹¤ë¡£
-.\"O .SH "RETURN VALUE"
-.SH ÊÖ¤êÃÍ
-.\"O The
-.\"O .BR wcstok ()
-.\"O function returns a pointer to the next token,
-.\"O or NULL if no further token was found.
-.BR wcstok ()
-´Ø¿ô¤Ï¼¡¤Î¥È¡¼¥¯¥ó¤Ø¤Î¥Ý¥¤¥ó¥¿¤òÊÖ¤¹¡£¥È¡¼¥¯¥ó¤¬¸«¤Ä¤«¤é
-¤Ê¤±¤ì¤Ð NULL ¤òÊÖ¤¹¡£
-.\"O .SH "CONFORMING TO"
-.SH ½àµò
+検索は \fIwcs\fP が NULL でなければ \fIwcs\fP から開始され、\fIwcs\fP が NULL ならば \fI*ptr\fP
+から開始される。まず、全ての区切りワイド文字 がスキップされる。つまり、\fIdelim\fP に含まれるワイド文字を超えるよう にポインタが前に進められる。
+ワイド文字文字列の終わりに達したら、 \fBwcstok\fP()  は NULL を返して トークンが全く見つからなかったことを示し、この後に
+\fBwcstok\fP()  を呼び 出しても NULL が返されるように \fI*ptr\fP に適切な値を設定する。それ 以外の場合には、
+\fBwcstok\fP()  関数はトークンの先頭を識別し、これを指す ポインタを返す。ただしこれを行う前に、トークンの後にある、\fIdelim\fP
+に含まれている文字を NULL ワイド文字 (L\(aq\e0\(aq) に置き換えること によってトークンを 0 で終端させる。さらに \fI*ptr\fP
+を更新し、後で \fBwcstok\fP()  を呼び出した 際に、識別されたトークンの続きから検索できるようにする。
+.SH 返り値
+\fBwcstok\fP()  関数は次のトークンへのポインタを返す。トークンが見つから なければ NULL を返す。
+.SH 準拠
 C99.
-.\"O .SH NOTES
-.SH Ãí°Õ
-.\"O The original \fIwcs\fP wide-character string is destructively modified during
-.\"O the operation.
-´Ø¿ô¤ËÍ¿¤¨¤¿¥ï¥¤¥Éʸ»úÎó \fIwcs\fP ¤Ï¡¢´Ø¿ô¤ÎÆ°ºî¤Ë¤è¤Ã¤Æ´°Á´¤Ë½ñ¤­´¹
-¤¨¤é¤ì¤ë¡£
-.\"O .SH EXAMPLE
-.SH Îã
-.\"O The following code loops over the tokens contained in a wide-character string.
-°Ê²¼¤Î¥³¡¼¥É¤Ï¡¢¥ï¥¤¥Éʸ»úʸ»úÎó¤Ë´Þ¤Þ¤ì¤ë¥È¡¼¥¯¥ó¤ò¼è¤ê½Ð¤·¤Ê¤¬¤é
-¥ë¡¼¥×¤¹¤ë¡£
+.SH 注意
+関数に与えたワイド文字列 \fIwcs\fP は、関数の動作によって完全に書き換 えられる。
+.SH 例
+以下のコードは、ワイド文字文字列に含まれるトークンを取り出しながら ループする。
 .sp
 .nf
 wchar_t *wcs = ...;
 wchar_t *token;
 wchar_t *state;
-for (token = wcstok(wcs, " \\t\\n", &state);
+for (token = wcstok(wcs, " \et\en", &state);
     token != NULL;
-    token = wcstok(NULL, " \\t\\n", &state)) {
+    token = wcstok(NULL, " \et\en", &state)) {
     ...
 }
 .fi
-.\"O .SH "SEE ALSO"
-.SH ´ØÏ¢¹àÌÜ
-.BR strtok (3),
-.BR wcschr (3)
+.SH 関連項目
+\fBstrtok\fP(3), \fBwcschr\fP(3)
+.SH この文書について
+この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
+である。プロジェクトの説明とバグ報告に関する情報は
+http://www.kernel.org/doc/man\-pages/ に書かれている。