libexplain  1.4.D001
Functions
libexplain/buffer/errno/stat.h File Reference

Go to the source code of this file.

Functions

void explain_buffer_errno_stat (struct explain_string_buffer_t *sb, int errnum, const char *path, const struct stat *stp)
void explain_buffer_errno_stat_explanation (struct explain_string_buffer_t *sb, int errnum, const char *syscall_name, const char *path, const struct stat *stp)

Function Documentation

void explain_buffer_errno_stat ( struct explain_string_buffer_t sb,
int  errnum,
const char *  path,
const struct stat *  stp 
)

The explain_buffer_errno_stat function is used to obtain an explanation of an error returned by the stat(2) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

Parameters:
sbThe string buffer in which the message is being constructed. If a safe buffer is specified, this function is thread safe.
errnumThe error value to be decoded, usually obtain from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
pathThe original path, exactly has passed to the stat(2) system call.
stpThe original stp, exactly has passed to the stat(2) system call.

Definition at line 117 of file stat.c.

void explain_buffer_errno_stat_explanation ( struct explain_string_buffer_t sb,
int  errnum,
const char *  syscall_name,
const char *  path,
const struct stat *  stp 
)

The explain_buffer_errno_stat_explanation function is used to write the explanation (after "because") of an error returned by the stat(2) system call.

Parameters:
sbThe string buffer in which the message is being constructed. If a safe buffer is specified, this function is thread safe.
errnumThe error value to be decoded, usually obtain from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
syscall_nameThe name of the offended system call.
pathThe original path, exactly has passed to the stat(2) system call.
stpThe original stp, exactly has passed to the stat(2) system call.

Definition at line 54 of file stat.c.