ACLGETENTRY(3) BSD Library Functions Manual ACLGETENTRY(3)
NAME
aclgetentry -- retrieve an ACL entry from an ACL
LIBRARY
Standard C Library (libc, -lc)
SYNOPSIS
##include <>
##include <>
int
aclgetentry(aclt acl, int entryid, aclentryt *entryp);
DESCRIPTION
The aclgetentry() function is a POSIX.1e call that retrieves a descrip-
tor for an ACL entry specified by the argument entryd within the ACL
indicated by the argument acl.
If the value of entryid is ACLFIRSTENTRY, then the function will
return in entryp a descriptor for the first ACL entry within acl. If a
call is made to aclgetentry() with entryid set to ACLNEXTENTRY when
there has not been either an initial successful call to aclgetentry(),
or a previous successfull call to aclcreateentry(), acldeleteentry(),
acldup(), aclfromtext(), aclgetfd(), aclgetfile(), aclsetfd(),
aclsetfile(), or aclvalid(), then the result is unspecified.
The caller may also set entryid to the index of the desired entry within
the ACL. This is a non-portable extension. A subsequent call with
entryid set to ACLNEXTENTRY will return the entry following the previ-
ously nominated entry and so forth.
RETURN VALUES
If the aclgetentry() function successfully obtains an ACL entry, a
value of 1 is returned. If the ACL has no ACL entries, the
aclgetentry() returns a value of 0. If the value of entryid is
ACLNEXTENTRY and the last ACL entry in the ACL has already been
returned by a previous call to aclgetentry(), a value of 0 will be
returned until a successful call with entryid of ACLFIRSTENTRY is
made. Otherwise, a value of -1 will be returned and the global variable
errno will be set to indicate the error.
ERORS
The aclgetentry() fails if:
[EINVAL] Argument acl does not point to a valid ACL. Argument
entryid is neither ACLFIRSTENTRY, ACLNEXTENTRY or
a valid entry index.
SEE ALSO
acl(3), aclcalcmask(3), aclcreateentry(3), acldeleteentry(3),
acldup(3), aclfromtext(3), aclgetfd(3), aclgetfile(3),
aclinit(3), aclsetfd(3), aclsetfile(3), aclvalid(3), posix1e(3)
STANDARDS
POSIX.1e is described in IE POSIX.1e draft 17.
AUTHORS
Michael Smith
Chris D. Faulhaber
BSD April 13, 2001 BSD
|