Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

acl_get_file(3) [centos man page]

ACL_GET_FILE(3) 					   BSD Library Functions Manual 					   ACL_GET_FILE(3)

NAME
acl_get_file -- get an ACL by filename LIBRARY
Linux Access Control Lists library (libacl, -lacl). SYNOPSIS
#include <sys/types.h> #include <sys/acl.h> acl_t acl_get_file(const char *path_p, acl_type_t type); DESCRIPTION
The acl_get_file() function retrieves the access ACL associated with a file or directory, or the default ACL associated with a directory. The pathname for the file or directory is pointed to by the argument path_p. The ACL is placed into working storage and acl_get_file() returns a pointer to that storage. In order to read an ACL from an object, a process must have read access to the object's attributes. The value of the argument type is used to indicate whether the access ACL or the default ACL associated with path_p is returned. If type is ACL_TYPE_ACCESS, the access ACL of path_p is returned. If type is ACL_TYPE_DEFAULT, the default ACL of path_p is returned. If type is ACL_TYPE_DEFAULT and no default ACL is associated with the directory path_p, then an ACL containing zero ACL entries is returned. If type specifies a type of ACL that cannot be associated with path_p, then the function fails. This function may cause memory to be allocated. The caller should free any releasable memory, when the new ACL is no longer required, by calling acl_free(3) with the (void*)acl_t returned by acl_get_file() as an argument. RETURN VALUE
On success, this function returns a pointer to the working storage. On error, a value of (acl_t)NULL is returned, and errno is set appropri- ately. ERRORS
If any of the following conditions occur, the acl_get_file() function returns a value of (acl_t)NULL and sets errno to the corresponding value: [EACCES] Search permission is denied for a component of the path prefix or the object exists and the process does not have appro- priate access rights. Argument type specifies a type of ACL that cannot be associated with path_p. [EINVAL] The argument type is not ACL_TYPE_ACCESS or ACL_TYPE_DEFAULT. [ENAMETOOLONG] The length of the argument path_p is too long. [ENOENT] The named object does not exist or the argument path_p points to an empty string. [ENOMEM] The ACL working storage requires more memory than is allowed by the hardware or system-imposed memory management con- straints. [ENOTDIR] A component of the path prefix is not a directory. [ENOTSUP] The file system on which the file identified by path_p is located does not support ACLs, or ACLs are disabled. STANDARDS
IEEE Std 1003.1e draft 17 ("POSIX.1e", abandoned) SEE ALSO
acl_free(3), acl_get_entry(3), acl_get_fd(3), acl_set_file(3), acl(5) AUTHOR
Derived from the FreeBSD manual pages written by Robert N M Watson <rwatson@FreeBSD.org>, and adapted for Linux by Andreas Gruenbacher <a.gruenbacher@bestbits.at>. Linux ACL March 23, 2002 Linux ACL

Check Out this Related Man Page

ACL_GET(3)						   BSD Library Functions Manual 						ACL_GET(3)

NAME
acl_get_fd, acl_get_fd_np, acl_get_file, acl_get_link_np -- get an ACL for a file LIBRARY
Standard C Library (libc, -lc) SYNOPSIS
#include <sys/types.h> #include <sys/acl.h> acl_t acl_get_fd(int fd); acl_t acl_get_fd_np(int fd, acl_type_t type); acl_t acl_get_file(const char *path_p, acl_type_t type); acl_t acl_get_link_np(const char *path_p, acl_type_t type); DESCRIPTION
The acl_get_fd(), acl_get_file(), acl_get_link_np(), and acl_get_fd_np() each allow the retrieval of an ACL from a file. The acl_get_fd() is a POSIX.1e call that allows the retrieval of an ACL of type ACL_TYPE_ACCESS from a file descriptor. The acl_get_fd_np() function is a non- portable form of acl_get_fd() that allows the retrieval of any type of ACL from a file descriptor. The acl_get_file() function is a POSIX.1e call that allows the retrieval of a specified type of ACL from a file by name; acl_get_link_np() is a non-portable variation on acl_get_file() which does not follow a symlink if the target of the call is a symlink. These functions may cause memory to be allocated. The caller should free any releasable memory, when the new ACL is no longer required, by calling acl_free(3) with the (void *)acl_t as an argument. The ACL in the working storage is an independent copy of the ACL associated with the object referred to by fd. The ACL in the working stor- age shall not participate in any access control decisions. RETURN VALUES
Upon successful completion, the function shall return a pointer to the ACL that was retrieved. Otherwise, a value of (acl_t)NULL shall be returned, and errno shall be set to indicate the error. ERRORS
If any of the following conditions occur, the acl_get_fd() function shall return a value of (acl_t)NULL and set errno to the corresponding value: [EACCES] Search permission is denied for a component of the path prefix, or the object exists and the process does not have appro- priate access rights. [EBADF] The fd argument is not a valid file descriptor. [EINVAL] The ACL type passed is invalid for this file object. [ENAMETOOLONG] A component of a pathname exceeded 255 characters, or an entire path name exceeded 1023 characters. [ENOENT] The named object does not exist, or the path_p argument points to an empty string. [ENOMEM] Insufficient memory available to fulfill request. [EOPNOTSUPP] The file system does not support ACL retrieval. SEE ALSO
acl(3), acl_free(3), acl_get(3), acl_set(3), posix1e(3) STANDARDS
POSIX.1e is described in IEEE POSIX.1e draft 17. AUTHORS
Michael Smith Robert N M Watson BSD
December 29, 2002 BSD
Man Page

Featured Tech Videos