explain_shmat_or_die man page

explain_shmat_or_die — shared memory attach and report errors

Synopsis

#include <libexplain/shmat.h>

void *explain_shmat_or_die(int shmid, const void *shmaddr, int shmflg);
void *explain_shmat_on_error(int shmid, const void *shmaddr, int shmflg);

Description

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

The explain_shmat_on_error function is used to call the shmat(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_shmat(3) function, but still returns to the caller.

shmid
The shmid, exactly as to be passed to the shmat(2) system call.
shmaddr
The shmaddr, exactly as to be passed to the shmat(2) system call.
shmflg
The shmflg, exactly as to be passed to the shmat(2) system call.

Return Value

The explain_shmat_or_die function only returns on success, see shmat(2) for more information. On failure, prints an explanation and exits, it does not return.

The explain_shmat_on_error function always returns the value return by the wrapped shmat(2) system call.

Example

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

void *result = explain_shmat_or_die(shmid, shmaddr, shmflg);

See Also

shmat(2)
shared memory attach
explain_shmat(3)
explain shmat(2) errors
exit(2)
terminate the calling process

Referenced By

explain(3), explain_shmat(3).