UNLINKAT
Section: Linux Programmer's Manual (2)
Updated: 2006-04-10
Index
JM Home Page
roff page
名前
unlinkat - ディレクトリファイルディスクリプタから相対的な位置にあるディレクトリエントリを削除する
書式
#define _ATFILE_SOURCE
#include <fcntl.h>
int unlinkat(int dirfd, const char *pathname, int flags);
説明
unlinkat()
システムコールは、この man ページで説明している違いがある以外は、
(flags
に
AT_REMOVEDIR
フラグが含まれるか否かにより)
unlink(2)
または
rmdir(2)
と全く同じように動作する。
pathname
で指定されるパス名が相対パス名である場合、
ファイルディスクリプタ
dirfd
で参照されるディレクトリからの相対パス名として解釈される
(unlink(2)
または
rmdir(2)
では、相対パスは呼び出し元プロセスの
カレントワーキングディレクトリからの相対パスとなる)。
pathname
で指定されるパス名が相対パス名であり、かつ
dirfd
が特別な値
AT_FDCWD
である場合、
pathname
は
(unlink(2)
または
rmdir(2)
と同じように) 呼び出し元プロセスの
カレントワーキングディレクトリからの相対パス名として解釈される。
pathname
で指定されるパス名が絶対パス名である場合、
dirfd
は無視される。
flags
はビットマスクであり、0 または
unlinkat()
の操作を制御するフラグ値の OR を指定できる。
現在のところ 1 つのフラグだけが定義されている:
- AT_REMOVEDIR
-
デフォルトでは、
unlinkat()
は
pathname
に対して
unlink(2)
と同じ操作を行う。
AT_REMOVEDIR
フラグが指定されると、
pathname
に対して
rmdir(2)
と同じ操作を行う。
返り値
成功した場合、
unlinkat()
は 0 を返す。
エラーの場合、-1 が返されて、
errno
にはエラーを示す値が設定される。
エラー
unlink(2)
または
rmdir(2)
と同じエラーが
unlinkat()
でも起こる。
unlinkat()
では、その他に以下のエラーが起こる:
- EBADF
-
dirfd
が有効なファイルディスクリプタでない。
- EINVAL
-
flags
に不正なフラグ値が指定された。
- ENOTDIR
-
pathname
が相対パスで、かつ
dirfd
がディレクトリ以外のファイルを参照するファイルディスクリプタである。
バージョン
unlinkat()
は Linux カーネル 2.6.16 で追加された。
準拠
このシステムコールは標準的ではないが、
POSIX.1 の将来のリビジョンに含めることが提案されている。
Solaris には、これと同じようなシステムコールが存在する。
注意
unlinkat()
が必要な理由については、
openat(2)
を参照すること。
関連項目
openat(2),
rmdir(2),
unlink(2),
path_resolution(7)
Index
- 名前
-
- 書式
-
- 説明
-
- 返り値
-
- エラー
-
- バージョン
-
- 準拠
-
- 注意
-
- 関連項目
-
This document was created by
man2html,
using the manual pages.
Time: 04:32:10 GMT, November 19, 2007