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
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.
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
Perform a pure create, which fails if the named attribute exists already.
Perform 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.
XATTR_REPLACE was specified, and the attribute does not exist.
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,
The file is marked immutable or append-only. (See ioctl_iflags(2).)
In addition, the errors documented in stat(2) can also occur.
The size of
value exceeds a filesystem-specific limit.
These system calls have been available on Linux since kernel 2.4; glibc support is provided since version 2.3.
These system calls are Linux-specific.
This page is part of release 5.05 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/.