acl_get or acl_fget Subroutine

Base Operating System and Extensions Technical Reference, Volume 1

acl_get or acl_fget Subroutine

Purpose

Gets the access control information of a file.

Library

Security Library (libc.a)

Syntax

#include <sys/access.h>

char *acl_get (Path)
char *Path;

char *acl_fget (FileDescriptor)
int FileDescriptor;

Description

The acl_get and acl_fget subroutines retrieve the access control information for a file system object. This information is returned in a buffer pointed to by the return value. The structure of the data in this buffer is unspecified. The value returned by these subroutines should be used only as an argument to the acl_put or acl_fput subroutines to copy or restore the access control information.

Parameters

Path	Specifies the path name of the file.
FileDescriptor	Specifies the file descriptor of an open file.

Return Values

On successful completion, the acl_get and acl_fget subroutines return a pointer to the buffer containing the access control information. Otherwise, a null pointer is returned and the errno global variable is set to indicate the error.

Error Codes

The acl_get subroutine fails if one or more of the following are true:

EACCES	Search permission is denied on a component of the Path prefix.
EFAULT	The Path parameter points to a location outside of the allocated address space of the process.
ELOOP	Too many symbolic links were encountered in translating the Path parameter.
ENAMETOOLONG	A component of the Path parameter exceeded 255 characters, or the entire Path parameter exceeded 1023 characters.
ENOTDIR	A component of the Path prefix is not a directory.
ENOENT	A component of the Path does not exist or the process has the disallow truncation attribute (see the ulimit subroutine).
ENOENT	The Path parameter was null.
ENOENT	A symbolic link was named, but the file to which it refers does not exist.
ESTALE	The process' root or current directory is located in a virtual file system that has been unmounted.

The acl_fget subroutine fails if the following is true:

EBADF

The FileDescriptor parameter is not a valid file descriptor.

The acl_get or acl_fget subroutine fails if the following is true:

EIO

An I/O error occurred during the operation.

If Network File System (NFS) is installed on your system, the acl_get and acl_fget subroutines can also fail if the following is true:

ETIMEDOUT

The connection timed out.

Security

Access Control	The invoker must have search permission for all components of the Path prefix.
Audit Events	None.

Implementation Specifics

These subroutines are part of Base Operating System (BOS) Runtime.

Related Information

The acl_chg or acl_fchg subroutine, acl_put or acl_fput subroutine, acl_set or acl_fset subroutine, chacl subroutine, chmod subroutine, stat subroutine, statacl subroutine.

The aclget command, aclput command, chmod command.

List of Security and Auditing Subroutines and Subroutines Overview in AIX Version 4.3 General Programming Concepts: Writing and Debugging Programs.