File: wcrtomb.3

package info (click to toggle)
manpages-ja 0.5.0.0.20180315%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 28,516 kB
  • sloc: perl: 161; makefile: 101
file content (68 lines) | stat: -rw-r--r-- 3,688 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
.\" 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
.\"   ISO/IEC 9899:1999
.\"
.\"*******************************************************************
.\"
.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
.\"
.\" Translated Mon Oct 25 22:55:40 JST 1999
.\"           by FUJIWARA Teruyoshi <fujiwara@linux.or.jp>
.\"
.TH WCRTOMB 3 2014\-03\-18 GNU "Linux Programmer's Manual"
.SH 名前
wcrtomb \- ワイド文字 1 つをマルチバイト列に変換する
.SH 書式
.nf
\fB#include <wchar.h>\fP
.sp
\fBsize_t wcrtomb(char *\fP\fIs\fP\fB, wchar_t \fP\fIwc\fP\fB, mbstate_t *\fP\fIps\fP\fB);\fP
.fi
.SH 説明
この関数が主に使われるのは、\fIs\fP が NULL でなく、 \fIwc\fP がヌルワイド文字 (L\(aq\e0\(aq) でない場合である。
この場合には、 \fBwcrtomb\fP()  関数はワイド文字 \fIwc\fP をマルチバイト表 現に変換し、\fIs\fP が指す char
型の配列にこれを格納する。この関数は シフト状態 \fI*ps\fP を更新し、出力されたマルチバイト表現の長さ、すな わち \fIs\fP
に書き込まれたバイト数を返す。
.PP
別のケースとしては、\fIs\fP は NULL でないが \fIwc\fP がヌルワイド文字 (L\(aq\e0\(aq) のことがある。 この場合の
\fBwcrtomb\fP()  関数は、\fI*ps\fP を初期状態に戻すのに必 要なシフトシーケンスを \fIs\fP が指す char 型配列に格納し、その後に
\(aq\e0\(aq を格納する。この関数はシフト状態 \fI*ps\fP を更新し(つまり初期状態に戻 し)、シフトシーケンスの長さに 1
を加えた値を返す。この値は \fIs\fP に 書き込まれたバイト数である。
.PP
三番目のケースは、\fIs\fP が NULL の時である。 この場合には \fIwc\fP は無視され、関数の実際の動きとしては

    wcrtomb(buf, L\(aq\e0\(aq, ps)

が返される。ここで、 \fIbuf\fP は内部的な無名バッファーである。
.PP
以上のいずれの場合も、\fIps\fP が NULL ならばシフト状態は用い られず、 \fBwcrtomb\fP()
関数だけが知っている静的な匿名の状態が使われる。
.SH 返り値
\fBwcrtomb\fP()  関数は、\fIs\fP が指すバイト列に書き込まれたバイト数、あ るいは書き込まれたであろうバイト数を返す。\fIwc\fP
を(現在のロケールに 従って)マルチバイト列で表現できなければ、 \fI(size_t)\ \-1\fP が返され、 \fIerrno\fP に \fBEILSEQ\fP
が設定される。
.SH 準拠
C99.
.SH 注意
\fBwcrtomb\fP()  の動作は、現在のロケールの \fBLC_CTYPE\fP カテゴリーに依存する。
.PP
\fIps\fP に NULL を渡した際の動作はマルチスレッドセーフでない。
.SH 関連項目
\fBmbsinit\fP(3), \fBwcsrtombs\fP(3)
.SH この文書について
この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.79 の一部
である。プロジェクトの説明とバグ報告に関する情報は
http://www.kernel.org/doc/man\-pages/ に書かれている。