2 .\" Copyright (c) 2003 Network Associates Technology, Inc.
3 .\" All rights reserved.
5 .\" This software was developed for the FreeBSD Project in part by Network
6 .\" Associates Laboratories, the Security Research Division of Network
7 .\" Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
8 .\" as part of the DARPA CHATS research program.
10 .\" Redistribution and use in source and binary forms, with or without
11 .\" modification, are permitted provided that the following conditions
13 .\" 1. Redistributions of source code must retain the above copyright
14 .\" notice, this list of conditions and the following disclaimer.
15 .\" 2. Redistributions in binary form must reproduce the above copyright
16 .\" notice, this list of conditions and the following disclaimer in the
17 .\" documentation and/or other materials provided with the distribution.
19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 .Nd retrieve a list of named extended attribute from a vnode
45 .Fa "struct vnode *vp"
46 .Fa "int attrnamespace"
49 .Fa "struct ucred *cred"
50 .Fa "struct thread *td"
53 This vnode call may be used to retrieve a list of named extended attributes
54 from a specified namespace on a file or directory.
57 .Bl -tag -width ".Fa attrnamespace"
59 The vnode of the file or directory.
61 Integer constant indicating which extended attribute namespace the attribute
64 The location of the data to be read.
65 The resulting data will be a list of attribute names.
66 Each list entry consists of a single byte containing the length of
67 the attribute name, followed by the attribute name.
68 The attribute name is not terminated by
74 on return it will contain the number of bytes required to read the list.
81 is not, and vise versa.
83 The user credentials to use in authorizing the request.
85 The thread requesting the extended attribute.
92 to indicate that access control checks are not to be performed, if possible.
95 setting might be used to allow the kernel to authorize extended attribute
96 retrieval that the active process might not be permitted to do.
98 Extended attribute semantics may vary by file system implementing the call.
99 More information on extended attributes may be found in
102 The vnode will be locked on entry and should remain locked on return.
104 On success, zero will be returned, and the
106 structure will be updated to
107 reflect the list read.
108 Otherwise, an appropriate error code is returned.
112 The caller does not have the appropriate privilege.
114 The request was not valid in this file system for the specified vnode and
117 Sufficient memory is not available to fulfill the request.
121 structure refers to an invalid userspace address.
129 The file system does not support
130 .Fn VOP_LISTEXTATTR .
135 .Xr VOP_GETEXTATTR 9 ,