setxattr, lsetxattr, fsetxattr — set an extended attribute value
#include <sys/types.h> #include <sys/xattr.h>
int
setxattr( |
const char *path, |
| const char *name, | |
| const void *value, | |
| size_t size, | |
int flags); |
int
lsetxattr( |
const char *path, |
| const char *name, | |
| const void *value, | |
| size_t size, | |
int flags); |
int
fsetxattr( |
int fd, |
| const char *name, | |
| const void *value, | |
| size_t size, | |
int flags); |
Extended attributes are name:value pairs associated with
inodes (files, directories, symbolic links, etc.). They are
extensions to the normal attributes which are associated with
all inodes in the system (i.e., the stat(2) data). A complete
overview of extended attributes concepts can be found in
xattr(7).
setxattr() sets the
value of the extended
attribute identified by name and associated with the
given path in the
filesystem. The size
argument specifies the size (in bytes) of value; a zero-length value is
permitted.
lsetxattr() is identical to
setxattr(), except in the case
of a symbolic link, where the extended attribute is set on
the link itself, not the file that it refers to.
fsetxattr() is identical to
setxattr(), only the extended
attribute is set on the open file referred to by fd (as returned by open(2)) in place of
path.
An extended attribute name is a null-terminated string.
The name includes a
namespace prefix; there may be several, disjoint namespaces
associated with an individual inode. The value of an extended attribute
is a chunk of arbitrary textual or binary data of specified
length.
By default (i.e., flags is zero), the extended
attribute will be created if it does not exist, or the value
will be replaced if the attribute already exists. To modify
these semantics, one of the following values can be specified
in flags:
XATTR_CREATEPerform a pure create, which fails if the named attribute exists already.
XATTR_REPLACEPerform a pure replace operation, which fails if the named attribute does not already exist.
On success, zero is returned. On failure, −1 is
returned and errno is set
appropriately.
Disk quota limits meant that there is insufficient space remaining to store the extended attribute.
XATTR_CREATE was
specified, and the attribute exists already.
ENOATTRXATTR_REPLACE was
specified, and the attribute does not exist.
(ENOATTR is defined to be
a synonym for ENODATA in
<attr/xattr.h>
There is insufficient space remaining to store the extended attribute.
The namespace prefix of name is not valid.
Extended attributes are not supported by the filesystem, or are disabled,
In addition, the errors documented in stat(2) can also occur.
These system calls have been available on Linux since kernel 2.4; glibc support is provided since version 2.3.
getfattr(1), setfattr(1), getxattr(2), listxattr(2), open(2), removexattr(2), stat(2), symlink(7), xattr(7)
This page is part of release 4.07 of the Linux man-pages project. A
description of the project, information about reporting bugs,
and the latest version of this page, can be found at
https://www.kernel.org/doc/man−pages/.
|
Copyright (C) Andreas Gruenbacher, February 2001 Copyright (C) Silicon Graphics Inc, September 2001 %%%LICENSE_START(GPLv2+_DOC_FULL) This is free documentation; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. The GNU General Public License's references to "object code" and "executables" are to be interpreted as the output of any document formatting or typesetting system, including intermediate and printed output. This manual is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this manual; if not, see <http://www.gnu.org/licenses/>. %%%LICENSE_END |