Veritas™ File System 5.0.1 Programmer's Reference Guide

Return values
A “0” indicates success; otherwise, the errno is set to error and a non-zero value
is returned.
vxfs_fcl_read
This function lets the application read the actual file or directory change
information recorded in the FCL as logical records. Each record returns a struct
fcl_record type. vxfs_fcl_read lets the application specify a filter comprising
a set of desired events.
Parameters
The following is the syntax for the vxfs_fcl_read function:
int vxfs_fcl_read(void *hndl, char *buf, size_t *bufsz, uint64_t eventmask,
uint32_t *nentries);
Input
This function has the following input:
■ *hndl is a pointer returned by a previous call to vxfs_fcl_open
■ *buf is a pointer to a buffer of size at least *bufsz
■ *bufsz specifies the buffer size
■ eventmask is a bit-mask that specifies a set of events which is of interest to
the application. It should be a “logical or” of a set of event masks specified in
the fcl.h header. For example, if the eventmask is (VX_FCL_CREATE_MASK |
VX_FCL_UNLINK_MASK), vxfs_fcl_read returns only file create and delete
records.
If an application needs to read all all the records listed in Table 2-1, it can
specify a default eventmask mask as FCL_ALL_V4_EVENTS.
This returns all valid Version 4 FCL records in the FCL file.
Note: If VX_FCL_EVENTMASKCHG_MASK is set in eventmask and the records
returned by vxfs_fcl_read contain a VX_FCL_EVENTMASK_CHG record, it is
always the last record in the buffer. This lets the application to readjust the
eventmask if required. In addition, if the application discovers from the
eventmask change record that a particular event is no longer recorded, it can
decide to stop further reading.
31File Change Log
Application programming interface for File Change Log