git.saurik.com Git - apple/libc.git/blob

1 .\"-

4 .\"

5 .\" Redistribution and use in source and binary forms, with or without

6 .\" modification, are permitted provided that the following conditions

7 .\" are met:

8 .\" 1. Redistributions of source code must retain the above copyright

9 .\" notice, this list of conditions and the following disclaimer.

10 .\" 2. Redistributions in binary form must reproduce the above copyright

11 .\" notice, this list of conditions and the following disclaimer in the

12 .\" documentation and/or other materials provided with the distribution.

13 .\"

14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND

15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR THE VOICES IN HIS HEAD BE

18 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

19 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

20 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

21 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

22 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

23 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

24 .\" POSSIBILITY OF SUCH DAMAGE.

25 .\"

26 .\" $FreeBSD: src/lib/libc/posix1e/acl_get_entry.3,v 1.6 2002/12/18 12:45:09 ru Exp $

27 .\"

28 .Dd April 13, 2001

29 .Dt ACL_GET_ENTRY 3

30 .Os

31 .Sh NAME

32 .Nm acl_get_entry

33 .Nd retrieve an ACL entry from an ACL

34 .Sh LIBRARY

35 .Lb libc

36 .Sh SYNOPSIS

37 .In sys/types.h

38 .In sys/acl.h

39 .Ft int

40 .Fn acl_get_entry "acl_t acl" "int entry_id" "acl_entry_t *entry_p"

41 .Sh DESCRIPTION

42 The

43 .Fn acl_get_entry

44 function

45 is a POSIX.1e call that retrieves a descriptor for an ACL entry

46 specified by the argument

47 .Fa entry_d

48 within the ACL indicated by the argument

49 .Fa acl .

50 .Pp

51 If the value of

52 .Fa entry_id

53 is

54 .Dv ACL_FIRST_ENTRY ,

55 then the function will return in

56 .Fa entry_p

57 a descriptor for the first ACL entry within

58 .Fa acl .

59 If a call is made to

60 .Fn acl_get_entry

61 with

62 .Fa entry_id

63 set to

64 .Dv ACL_NEXT_ENTRY

65 when there has not been either an initial successful call to

66 .Fn acl_get_entry ,

67 or a previous successfull call to

68 .Fn acl_create_entry ,

69 .Fn acl_delete_entry ,

70 .Fn acl_dup ,

71 .Fn acl_from_text ,

72 .Fn acl_get_fd ,

73 .Fn acl_get_file ,

74 .Fn acl_set_fd ,

75 .Fn acl_set_file ,

76 or

77 .Fn acl_valid ,

78 then the result is unspecified.

79 .Pp

80 The caller may also set

81 .Fa entry_id

82 to the index of the desired entry within the ACL. This is a non-portable

83 extension. A subsequent call with

84 .Fa entry_id

85 set to

86 .Dv ACL_NEXT_ENTRY

87 will return the entry following the previously nominated entry and so forth.

88 .Sh RETURN VALUES

89 If the

90 .Fn acl_get_entry

91 function successfully obtains an ACL entry, a value of 0 is returned.

92 Otherwise, a value of -1 will be returned and

93 the global variable

94 .Va errno

95 will be set to indicate the error.

96 .Sh ERRORS

97 The

98 .Fn acl_get_entry

99 fails if:

100 .Bl -tag -width Er

101 .It Bq Er EINVAL

102 Argument

103 .Fa acl

104 does not point to a valid ACL. Argument

105 .Fa entry_id

106 is neither

107 .Dv ACL_FIRST_ENTRY ,

108 .Dv ACL_NEXT_ENTRY

109 or a valid entry index.

110 .It Bq Er EINVAL

111 The value of

112 .Fa entry_id

113 is

114 .Dv ACL_NEXT_ENTRY

115 and the last ACL entry in the ACL has already been returned by a

116 previous call to

117 .Fn acl_get_entry .

118 .El

119 .Sh SEE ALSO

120 .Xr acl 3 ,

121 .Xr acl_calc_mask 3 ,

122 .Xr acl_create_entry 3 ,

123 .Xr acl_delete_entry 3 ,

124 .Xr acl_dup 3 ,

125 .Xr acl_from_text 3 ,

126 .Xr acl_get_fd 3 ,

127 .Xr acl_get_file 3 ,

128 .Xr acl_init 3 ,

129 .Xr acl_set_fd 3 ,

130 .Xr acl_set_file 3 ,

131 .Xr acl_valid 3 ,

132 .Xr posix1e 3

133 .Sh STANDARDS

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

135 .Sh AUTHORS

136 .An Michael Smith

137 .An Chris D. Faulhaber