release/man3/ptsname.3

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\" This page is in the public domain. - aeb
   3 .\"
   4 .\" 2004-12-17, mtk, added description of ptsname_r() + ERRORS
   5 .\"
   6 .\"*******************************************************************
   7 .\"
   8 .\" This file was generated with po4a. Translate the source file.
   9 .\"
  10 .\"*******************************************************************
  11 .TH PTSNAME 3 2008\-09\-03 "" "Linux Programmer's Manual"
  12 .SH 名前
  13 ptsname, ptsname_r \- スレーブ擬似端末の名前を取得する
  14 .SH 書式
  15 .nf
  16 \fB#define _XOPEN_SOURCE\fP       /* feature_test_macros(7) 参照 */
  17 .br
  18 \fB#include <stdlib.h>\fP
  19 .sp
  20 \fBchar *ptsname(int \fP\fIfd\fP\fB);\fP
  21 .sp
  22 \fB#define _GNU_SOURCE\fP         /* feature_test_macros(7) 参照 */
  23 .br
  24 \fB#include <stdlib.h>\fP
  25 .sp
  26 \fBint ptsname_r(int \fP\fIfd\fP\fB, char *\fP\fIbuf\fP\fB, size_t \fP\fIbuflen\fP\fB);\fP
  27 .fi
  28 .SH 説明
  29 \fBptsname\fP()  関数は \fIfd\fP で参照されるマスタ擬似端末 (pts) デバイスに対応する スレーブ擬似端末デバイスの名前を返す。
  30
  31 \fBptsname_r\fP()  関数は \fBptsname\fP()  のリエントラントなバージョンである。 この関数は、スレーブ疑似端末デバイスの名前を、
  32 NULL で終端された文字列の形で \fIbuf\fP で指定されたバッファに格納して返す。 \fIbuflen\fP 引き数には \fIbuf\fP
  33 のバイト数を指定する。
  34 .SH 返り値
  35 成功の場合、 \fBptsname\fP()  は静的記憶領域の文字列へのポインタを返す。 この記憶領域はこの後の \fBptsname\fP()
  36 の呼び出しで上書きされる。 このポインタを free してはいけない。 エラーの場合は NULL ポインタを返す。
  37
  38 .\" In fact the errno value is also returned as the function
  39 .\" result -- MTK, Dec 04
  40 成功の場合、 \fBptsname_r\fP()  は 0 を返す。 エラーの場合、0 以外の値を返し、 \fIerrno\fP をエラーを示す値に設定する。
  41 .SH エラー
  42 .TP
  43 \fBEINVAL\fP
  44 (\fBptsname_r\fP()  のみ)  \fIbuf\fP が NULL である。
  45 .TP
  46 \fBENOTTY\fP
  47 \fIfd\fP がマスタ疑似端末デバイスを参照していない。
  48 .TP
  49 \fBERANGE\fP
  50 (\fBptsname_r\fP()  のみ)  \fIbuf\fP が小さすぎる。
  51 .SH バージョン
  52 \fBptsname\fP()  は、バージョン 2.1 以降の glibc で提供されている。
  53 .SH 準拠
  54 \fBptsname\fP()  は UNIX 98 疑似端末仕様の一部である (\fBpts\fP(4)  を参照のこと)。この関数は POSIX.1\-2001
  55 で規定されている。
  56
  57 \fBptsname_r\fP()  は Linux による拡張である。 この関数についての記載があるものとして Tru64 と HP\-UX があるが、
  58 これらの OS での実装ではエラーの場合 \-1 を返し、 \fIerrno\fP にエラーを示す値を設定する。
  59 移植を考慮したプログラムではこの関数の使用は避けること。
  60 .SH 関連項目
  61 \fBgrantpt\fP(3), \fBposix_openpt\fP(3), \fBttyname\fP(3), \fBunlockpt\fP(3), \fBpts\fP(4),
  62 \fBpty\fP(7)