explain_shmctl_or_die3
Shared memory control and report errors
Usage
#include <libexplain/shmctl.h>
void explain_shmctl_or_die(int shmid, int command, struct shmid_ds *data);
int explain_shmctl_on_error(int shmid, int command, struct shmid_ds *data);
Overview
The explain_shmctl_or_die function is used to call the shmctl(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_shmctl(3) function, and then the process terminates by calling exit(EXIT_FAILURE).
The explain_shmctl_on_error function is used to call the shmctl(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_shmctl(3) function, but still returns to the caller.
shmid
|
The shmid, exactly as to be passed to the shmctl(2) system call. |
|---|---|
command
|
The command, exactly as to be passed to the shmctl(2) system call. |
data
|
The data, exactly as to be passed to the shmctl(2) system call. |
Return value
The explain_shmctl_or_die function only returns on success, see shmctl(2) for more information. On failure, prints an explanation and exits, it does not return.
The explain_shmctl_on_error function always returns the value return by the wrapped shmctl(2) system call.
Examples
The explain_shmctl_or_die function is intended to be used in a fashion similar to the following example:
explain_shmctl_or_die(shmid, command, data);Releases
6 releases since Debian 7 (Wheezy); the text changed 1 time.