Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

acl_get_entry(3) [freebsd man page]

ACL_GET_ENTRY(3)					   BSD Library Functions Manual 					  ACL_GET_ENTRY(3)

NAME

     acl_get_entry -- retrieve an ACL entry from an ACL

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #include <sys/types.h>
     #include <sys/acl.h>

     int
     acl_get_entry(acl_t acl, int entry_id, acl_entry_t *entry_p);

DESCRIPTION

     The acl_get_entry() function is a POSIX.1e call that retrieves a descriptor for an ACL entry specified by the argument entry_d within the ACL
     indicated by the argument acl.

     If the value of entry_id is ACL_FIRST_ENTRY, then the function will return in entry_p a descriptor for the first ACL entry within acl.  If a
     call is made to acl_get_entry() with entry_id set to ACL_NEXT_ENTRY when there has not been either an initial successful call to
     acl_get_entry(), or a previous successful call to acl_create_entry(), acl_delete_entry(), acl_dup(), acl_from_text(), acl_get_fd(),
     acl_get_file(), acl_set_fd(), acl_set_file(), or acl_valid(), then the result is unspecified.

RETURN VALUES

     If the acl_get_entry() function successfully obtains an ACL entry, a value of 1 is returned.  If the ACL has no ACL entries, the
     acl_get_entry() returns a value of 0.  If the value of entry_id is ACL_NEXT_ENTRY and the last ACL entry in the ACL has already been returned
     by a previous call to acl_get_entry(), a value of 0 will be returned until a successful call with entry_id of ACL_FIRST_ENTRY is made.  Oth-
     erwise, a value of -1 will be returned and the global variable errno will be set to indicate the error.

ERRORS

     The acl_get_entry() fails if:

     [EINVAL]		Argument acl does not point to a valid ACL.  Argument entry_id is neither ACL_FIRST_ENTRY nor ACL_NEXT_ENTRY.

SEE ALSO

     acl(3), acl_calc_mask(3), acl_create_entry(3), acl_delete_entry(3), acl_dup(3), acl_from_text(3), acl_get_fd(3), acl_get_file(3),
     acl_init(3), acl_set_fd(3), acl_set_file(3), acl_valid(3), posix1e(3)

STANDARDS

     POSIX.1e is described in IEEE POSIX.1e draft 17.

HISTORY

     POSIX.1e support was introduced in FreeBSD 4.0.  The acl_get_entry() function was added in FreeBSD 5.0.

AUTHORS

     The acl_get_entry() function was written by Chris D. Faulhaber <jedgar@fxp.org>.

BSD
								  April 13, 2001							       BSD

Check Out this Related Man Page

ACL_CREATE_ENTRY(3)					   BSD Library Functions Manual 				       ACL_CREATE_ENTRY(3)

NAME

     acl_create_entry, acl_create_entry_np -- create a new ACL entry

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #include <sys/types.h>
     #include <sys/acl.h>

     int
     acl_create_entry(acl_t *acl_p, acl_entry_t *entry_p);

     int
     acl_create_entry_np(acl_t *acl_p, acl_entry_t *entry_p, int entry_index);

DESCRIPTION

     The acl_create_entry() function is a POSIX.1e call that creates a new ACL entry in the ACL pointed to by acl_p.  The function will return in
     entry_p a descriptor for this ACL entry.

     The acl_create_entry_np() function is a non-portable extension which allows the caller to specify the position of the created entry within
     the ACL.  If entry_index is ACL_FIRST_ENTRY the entry will be created at the head of the ACL.  If entry_index is ACL_LAST_ENTRY the entry
     will be created at the end of the ACL.  After inserting an ACL entry with an entry_index other than ACL_LAST_ENTRY the behaviour of any
     acl_entry_t's previously obtained from the ACL by acl_create_entry() or acl_get_entry() is undefined.

RETURN VALUES

     The acl_create_entry() function returns the value 0 if successful; otherwise the value -1 is returned and the global variable errno is set to
     indicate the error.

ERRORS

     The acl_create_entry() and acl_create_entry_np() functions fail if:

     [EINVAL]		Argument acl_p does not point to a pointer to a valid ACL.

     [ENOMEM]		The ACL working storage requires more memory than is allowed by the hardware or system-imposed memory management con-
			straints.

     [ERANGE]		The entry_index argument to acl_create_entry_np() is greater than the number of entries in the ACL.

SEE ALSO

     acl(3), acl_delete_entry(3), acl_get_entry(3), posix1e(3)

STANDARDS

     POSIX.1e is described in IEEE POSIX.1e draft 17.

AUTHORS

     Michael Smith
     Chris D Fulhaber

BSD
								  March 16, 2001							       BSD
Man Page