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 .\" Japanese Version Copyright (c) 2003  Akihiro MOTOKI
   7 .\"         all rights reserved.
   8 .\" Translated 2003-07-08, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
   9 .\" Updated 2005-02-27, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  10 .\"
  11 .\"WORD:        pseudoterminal          擬似端末
  12 .\"
  13 .TH PTSNAME 3 2008-09-03 "" "Linux Programmer's Manual"
  14 .SH 名前
  15 ptsname, ptsname_r \- スレーブ擬似端末の名前を取得する
  16 .SH 書式
  17 .nf
  18 .BR "#define _XOPEN_SOURCE" "       /* feature_test_macros(7) 参照 */"
  19 .br
  20 .B #include <stdlib.h>
  21 .sp
  22 .BI "char *ptsname(int " fd ");"
  23 .sp
  24 .BR "#define _GNU_SOURCE" "         /* feature_test_macros(7) 参照 */"
  25 .br
  26 .B #include <stdlib.h>
  27 .sp
  28 .BI "int ptsname_r(int " fd ", char *" buf ", size_t " buflen ");"
  29 .fi
  30 .SH 説明
  31 .BR ptsname ()
  32 関数は
  33 .I fd
  34 で参照されるマスタ擬似端末 (pts) デバイスに対応する
  35 スレーブ擬似端末デバイスの名前を返す。
  36
  37 .BR ptsname_r ()
  38 関数は
  39 .BR ptsname ()
  40 のリエントラントなバージョンである。
  41 この関数は、スレーブ疑似端末デバイスの名前を、
  42 NULL で終端された文字列の形で
  43 .I buf
  44 で指定されたバッファに格納して返す。
  45 .I buflen
  46 引き数には
  47 .I buf
  48 のバイト数を指定する。
  49 .SH 返り値
  50 成功の場合、
  51 .BR ptsname ()
  52 は静的記憶領域の文字列へのポインタを返す。
  53 この記憶領域はこの後の
  54 .BR ptsname ()
  55 の呼び出しで上書きされる。
  56 このポインタを free してはいけない。
  57 エラーの場合は NULL ポインタを返す。
  58
  59 成功の場合、
  60 .BR ptsname_r ()
  61 は 0 を返す。
  62 エラーの場合、0 以外の値を返し、
  63 .I errno
  64 をエラーを示す値に設定する。
  65 .\" 実際には、errno の値が関数の結果の返り値としても返される。-- MTK, Dec 04
  66 .SH エラー
  67 .TP
  68 .B EINVAL
  69 .RB ( ptsname_r ()
  70 のみ)
  71 .I buf
  72 が NULL である。
  73 .TP
  74 .B ENOTTY
  75 .I fd
  76 がマスタ疑似端末デバイスを参照していない。
  77 .TP
  78 .B ERANGE
  79 .RB ( ptsname_r ()
  80 のみ)
  81 .I buf
  82 が小さすぎる。
  83 .SH バージョン
  84 .BR ptsname ()
  85 は、バージョン 2.1 以降の glibc で提供されている。
  86 .SH 準拠
  87 .BR ptsname ()
  88 は UNIX 98 疑似端末仕様の一部である
  89 .RB ( pts (4)
  90 を参照のこと)。この関数は POSIX.1-2001 で規定されている。
  91
  92 .BR ptsname_r ()
  93 は Linux による拡張である。
  94 この関数についての記載があるものとして Tru64 と HP-UX があるが、
  95 これらの OS での実装ではエラーの場合 \-1 を返し、
  96 .I errno
  97 にエラーを示す値を設定する。
  98 移植を考慮したプログラムではこの関数の使用は避けること。
  99 .SH 関連項目
 100 .BR grantpt (3),
 101 .BR posix_openpt (3),
 102 .BR ttyname (3),
 103 .BR unlockpt (3),
 104 .BR pts (4),
 105 .BR pty (7)