libexplain  1.4.D001
Functions
libexplain/readlink_or_die.c File Reference
#include <libexplain/ac/unistd.h>
#include <libexplain/output.h>
#include <libexplain/readlink.h>

Go to the source code of this file.

Functions

ssize_t explain_readlink_or_die (const char *pathname, char *data, size_t data_size)

Function Documentation

ssize_t explain_readlink_or_die ( const char *  pathname,
char *  data,
size_t  data_size 
)

The explain_readlink_or_die function is used to call the readlink(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_readlink(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

This function is intended to be used in a fashion similar to the following example:

 ssize_t result = explain_readlink_or_die(pathname, data, data_size);
Parameters:
pathnameThe pathname, exactly as to be passed to the readlink(2) system call.
dataThe data, exactly as to be passed to the readlink(2) system call.
data_sizeThe data_size, exactly as to be passed to the readlink(2) system call.
Returns:
This function only returns on success. On failure, prints an explanation and exits, it does not return.

Definition at line 26 of file readlink_or_die.c.