UNLINKAT(2)

名前
unlinkat - ディレクトリファイルディスクリプタから相対的な位置にあるディレクトリエントリを削除する

書式
#include <fcntl.h> /* AT_* 定数の定義 */
#include <unistd.h>

int unlinkat(int dirfd, const char *pathname, int flags);

glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):

unlinkat():
    glibc 2.10 以降:
        _XOPEN_SOURCE >= 700 || _POSIX_C_SOURCE >= 200809L
    glibc 2.10 より前:
        _ATFILE_SOURCE

説明
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 で追加された。 ライブラリによるサポートは glibc バージョン 2.4 で追加された。

準拠
POSIX.1-2008. Solaris には、これと同じようなシステムコールが存在する。

注意
unlinkat() が必要な理由については、 openat(2) を参照すること。

関連項目
openat(2), rmdir(2), unlink(2), path_resolution(7)

この文書について
この man ページは Linux man-pages プロジェクトのリリース 3.54 の一部 である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。