OSDN Git Service

(split) DP: release pages (catch up to 3.50).
[linuxjm/LDP_man-pages.git] / release / man3 / iconv_open.3
1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
2 .\"
3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
4 .\" This is free documentation; you can redistribute it and/or
5 .\" modify it under the terms of the GNU General Public License as
6 .\" published by the Free Software Foundation; either version 2 of
7 .\" the License, or (at your option) any later version.
8 .\" %%%LICENSE_END
9 .\"
10 .\" References consulted:
11 .\"   GNU glibc-2 source code and manual
12 .\"   OpenGroup's Single UNIX specification
13 .\"     http://www.UNIX-systems.org/online.html
14 .\"
15 .\" 2007-03-31 Bruno Haible, Describe the glibc/libiconv //TRANSLIT
16 .\" and //IGNORE extensions for 'tocode'.
17 .\"
18 .\"*******************************************************************
19 .\"
20 .\" This file was generated with po4a. Translate the source file.
21 .\"
22 .\"*******************************************************************
23 .TH ICONV_OPEN 3 2008\-08\-11 GNU "Linux Programmer's Manual"
24 .SH 名前
25 iconv_open \- 文字セット変換のためのディスクリプタを割り当てる
26 .SH 書式
27 .nf
28 \fB#include <iconv.h>\fP
29 .sp
30 \fBiconv_t iconv_open(const char *\fP\fItocode\fP\fB, const char *\fP\fIfromcode\fP\fB);\fP
31 .fi
32 .SH 説明
33 \fBiconv_open\fP()  関数は、文字エンコーディング \fIfromcode\fP から 文字エンコーディング \fItocode\fP
34 へのバイト文字列変換に適した 変換ディスクリプタを割り当てる。
35 .PP
36 \fIfromcode\fP と \fItocode\fP に使うことのできる値と、 サポートされる組み合わせは、システムに依存する。 GNU C
37 ライブラリでは、使うことのできる値は \fBiconv \-\-list\fP コマンドでリストされ、 リストされたすべての値の組み合わせがサポートされる。
38 さらに、 GNU C ライブラリと GNU libiconv ライブラリでは、 以下の接尾辞がサポートされている。
39 .TP 
40 //TRANSLIT
41 \fItocode\fP の後ろに文字列 "//TRANSLIT" が付いている場合、 翻訳 (transliteration) が有効になる。この場合、
42 変換先の文字セットで表現できない文字を、その文字と同じように見える 文字 (複数文字の場合もある) で表現することができる。
43 .TP 
44 //IGNORE
45 \fItocode\fP の後ろに文字列 "//IGNORE" が付いている場合、 変換先の文字セットで表現できない文字は黙って無視される。
46 .PP
47 この関数を読んで得られた変換ディスクリプタは、 \fBiconv\fP(3)  で 何度でも使うことができる。 これは \fBiconv_close\fP(3)
48 を使って解放されるまで有効である。
49 .PP
50 変換ディスクリプタは変換状態を持つ。 \fBiconv_open\fP()  を用いて生成された後、変換状態は初期状態である。 \fBiconv\fP(3)
51 を使うことにより、ディスクリプタの変換状態が変更される。 (変換ディスクリプタはマルチスレッドで 同時に使うことができないことを意味している。)
52 変換状態を初期状態に戻すには、 \fIinbuf\fP 引き数を NULL として \fBiconv\fP(3)  を用いること。
53 .SH 返り値
54 \fBiconv_open\fP()  関数は、新たに割り当てられた変換ディスクリプタを返す。 エラーの場合、この関数は \fIerrno\fP を設定し、
55 \fI(iconv_t)\ \-1\fP を返す。
56 .SH エラー
57 他のいろいろなエラーのうち、以下のエラーが起こりうる。
58 .TP 
59 \fBEINVAL\fP
60 \fIfromcode\fP から \fItocode\fP への変換は、この実装ではサポートされていない。
61 .SH バージョン
62 この関数はバージョン 2.1 以降の glibc で利用可能である。
63 .SH 準拠
64 UNIX98, POSIX.1\-2001.
65 .SH 関連項目
66 \fBiconv\fP(1), \fBiconv\fP(3), \fBiconv_close\fP(3)
67 .SH この文書について
68 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.50 の一部
69 である。プロジェクトの説明とバグ報告に関する情報は
70 http://www.kernel.org/doc/man\-pages/ に書かれている。