Manpage of INOTIFY_ADD_WATCH

INOTIFY_ADD_WATCH

Section: Linux Programmer's Manual (2)
Updated: 2014-07-08
Index
 

NAME

inotify_add_watch - add a watch to an initialized inotify instance  

SYNOPSIS

#include <sys/inotify.h>

int inotify_add_watch(int fd, const char *pathname, uint32_t mask); 

DESCRIPTION

inotify_add_watch() adds a new watch, or modifies an existing watch, for the file whose location is specified in pathname; the caller must have read permission for this file. The fdargument is a file descriptor referring to the inotify instance whose watch list is to be modified. The events to be monitored for pathnameare specified in the maskbit-mask argument. See inotify(7) for a description of the bits that can be set in mask.

A successful call to inotify_add_watch() returns a unique watch descriptor for this inotify instance, for the filesystem object that corresponds to pathname. If the filesystem object was not previously being watched by this inotify instance, then the watch descriptor is newly allocated. If the filesystem object was already being watched (perhaps via a different link to the same object), then the descriptor for the existing watch is returned.

The watch descriptor is returned by later read(2)s from the inotify file descriptor. These reads fetch inotify_eventstructures (see inotify(7)) indicating filesystem events; the watch descriptor inside this structure identifies the object for which the event occurred.  

RETURN VALUE

On success, inotify_add_watch() returns a nonnegative watch descriptor. On error, -1 is returned and errnois set appropriately.  

ERRORS

EACCES
Read access to the given file is not permitted.
EBADF
The given file descriptor is not valid.
EFAULT
pathnamepoints outside of the process's accessible address space.
EINVAL
The given event mask contains no valid events; or fdis not an inotify file descriptor.
ENAMETOOLONG
pathnameis too long.
ENOENT
A directory component in pathnamedoes not exist or is a dangling symbolic link.
ENOMEM
Insufficient kernel memory was available.
ENOSPC
The user limit on the total number of inotify watches was reached or the kernel failed to allocate a needed resource.
 

VERSIONS

Inotify was merged into the 2.6.13 Linux kernel.  

CONFORMING TO

This system call is Linux-specific.  

SEE ALSO

inotify_init(2), inotify_rm_watch(2), inotify(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:44 GMT, June 20, 2016