release/man3/iconv_open.3

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