Manpage of SETXATTR

SETXATTR

Section: Linux Programmer's Manual (2)
Updated: 2015-05-07
Index
 

NAME

setxattr, lsetxattr, fsetxattr - set an extended attribute value  

SYNOPSIS

#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);
 

DESCRIPTION

Extended attributes are name:valuepairs 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 valueof the extended attribute identified by nameand associated with the given pathin the filesystem. The sizeargument 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 nameincludes a namespace prefix; there may be several, disjoint namespaces associated with an individual inode. The valueof an extended attribute is a chunk of arbitrary textual or binary data of specified length.

By default (i.e., flagsis 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_CREATE
Perform a pure create, which fails if the named attribute exists already.
XATTR_REPLACE
Perform a pure replace operation, which fails if the named attribute does not already exist.
 

RETURN VALUE

On success, zero is returned. On failure, -1 is returned and errnois set appropriately.  

ERRORS

EDQUOT
Disk quota limits meant that there is insufficient space remaining to store the extended attribute.
EEXIST
XATTR_CREATEwas specified, and the attribute exists already.
ENOATTR
XATTR_REPLACEwas specified, and the attribute does not exist. (ENOATTRis defined to be a synonym for ENODATAin <attr/xattr.h>.)
ENOSPC
There is insufficient space remaining to store the extended attribute.
ENOTSUP
The namespace prefix of nameis not valid.
ENOTSUP
Extended attributes are not supported by the filesystem, or are disabled,

In addition, the errors documented in stat(2) can also occur.  

VERSIONS

These system calls have been available on Linux since kernel 2.4; glibc support is provided since version 2.3.  

CONFORMING TO

These system calls are Linux-specific.  

SEE ALSO

getfattr(1), setfattr(1), getxattr(2), listxattr(2), open(2), removexattr(2), stat(2), symlink(7), xattr(7)


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
ERRORS
VERSIONS
CONFORMING TO
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 22:27:41 GMT, June 20, 2016