release/man3/fpathconf.3

   1 .\" Copyright (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\" License.
  23 .\" Modified Wed Jul 28 11:12:26 1993 by Rik Faith (faith@cs.unc.edu)
  24 .\"
  25 .\" Japanese Version Copyright (c) 1998 NAKANO Takeo all rights reserved.
  26 .\" Translated Fri Mar 20 1998 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
  27 .\"
  28 .TH FPATHCONF 3  1993-04-04 "GNU" "Linux Programmer's Manual"
  29 .SH 名前
  30 fpathconf, pathconf \- ファイルの設定値を取得する
  31 .SH 書式
  32 .nf
  33 .B #include <unistd.h>
  34 .sp
  35 .BI "long fpathconf(int " fd ", int " name );
  36 .br
  37 .BI "long pathconf(char *" path ", int " name );
  38 .fi
  39 .SH 説明
  40 .BR fpathconf ()
  41 はオープンされているファイルデスクリプター
  42 .I fd
  43 に対して設定されているオプション
  44 .I name
  45 の値を取得する。
  46 .PP
  47 .BR pathconf ()
  48 はファイル名
  49 .I path
  50 に対して設定されているオプション
  51 .I name
  52 の値を取得する。
  53 .PP
  54 対応するマクロのうち
  55 .I <unistd.h>
  56 で定義されているものは最小値である。アプリケーションによってはこれらの
  57 値を変更してより有利な動作を行おうとするものがある。この場合でも
  58 .BR fpathconf ()
  59 または
  60 .BR pathconf ()
  61 は呼び出すことができる。この場合はより大きな値が返ることになろう。
  62 .PP
  63 .I name
  64 を以下の定数のどれかにすると、対応する設定オプションが返される。
  65 .TP
  66 .B _PC_LINK_MAX
  67 ファイルへのリンクの最大数を返す。
  68 .I fd
  69 または
  70 .I path
  71 がディレクトリの場合は、この値はディレクトリ全体に適用される。対応する
  72 マクロは
  73 .B _POSIX_LINK_MAX
  74 である。
  75 .TP
  76 .B _PC_MAX_CANON
  77 フォーマット付き入力行の最大長を返す。このとき
  78 .I fd
  79 または
  80 .I path
  81 は端末を参照していなければならない。
  82 対応するマクロは
  83 .B _POSIX_MAX_CANON
  84 である。
  85 .TP
  86 .B _PC_MAX_INPUT
  87 入力行の最大長を返す。このとき
  88 .I fd
  89 または
  90 .I path
  91 は端末を参照していなければならない。
  92 対応するマクロは
  93 .B _POSIX_MAX_INPUT
  94 である。
  95 .TP
  96 .B _PC_NAME_MAX
  97 ディレクトリ
  98 .I path
  99 または
 100 .I fd
 101 内に、そのプロセスが作成することができるファイル名の最大長を返す。
 102 対応するマクロは
 103 .B _POSIX_NAME_MAX
 104 である。
 105 .TP
 106 .B _PC_PATH_MAX
 107 .I path
 108 または
 109 .I fd
 110 がカレントディレクトリの場合、相対パス名の最大長を返す。
 111 対応するマクロは
 112 .B _POSIX_PATH_MAX
 113 である。
 114 .TP
 115 .B _PC_PIPE_BUF
 116 パイプ (pipe) バッファのサイズを返す。このとき
 117 .I fd
 118 はパイプか FIFO を参照していなければならず、
 119 .I path
 120 は FIFO を参照していなければならない。
 121 対応するマクロは
 122 .B _POSIX_PIPE_BUF
 123 である。
 124 .TP
 125 .B _PC_CHOWN_RESTRICTED
 126 このファイルに対する
 127 .BR chown (2)
 128 の呼び出しが許されていない場合には 0 以外の値を返す。
 129 .I fd
 130 または
 131 .I path
 132 がディレクトリを参照している場合は、この制限はそのディレクトリのすべて
 133 のファイルに適用される。
 134 対応するマクロは
 135 .B _POSIX_CHOWN_RESTRICTED
 136 である。
 137 .TP
 138 .B _PC_NO_TRUNC
 139 アクセス中のファイル名が
 140 .B _POSIX_NAME_MAX
 141 よりも長く、エラーとなる場合には 0 以外の値を返す。
 142 対応するマクロは
 143 .B _POSIX_NAME_MAX
 144 である。
 145 .TP
 146 .B _PC_VDISABLE
 147 特殊文字 (special character) の処理が許されていない場合は 0 以外の値を
 148 返す。このとき
 149 .I fd
 150 または
 151 .I path
 152 は端末を参照していなければならない。
 153 .SH 返り値
 154 (存在していれば) 制限値が返される。要求されたリソースへのシステムの制
 155 限が存在していなければ \-1 が返され、
 156 .I errno
 157 は変更されない。エラーが起こった場合には \-1 が返され、
 158 .I errno
 159 がエラーに対応した値に設定される。
 160 .SH 準拠
 161 POSIX.1-2001.
 162 .SH 注意
 163 .I name
 164 に
 165 .B _PC_NAME_MAX
 166 を入れて返された値よりも長いファイル名を持つファイルが、与えられたディ
 167 レクトリに存在するかもしれない。
 168 .PP
 169 返り値は非常に大きな値になることもある。メモリーの割り当て用の値には大
 170 きすぎて適さないかも知れない。
 171 .SH 関連項目
 172 .BR getconf (1),
 173 .BR open (2),
 174 .BR statfs (2),
 175 .BR sysconf (3)