libexplain/shmat_or_die.c File Reference

#include <libexplain/ac/errno.h>
#include <libexplain/ac/sys/shm.h>
#include <libexplain/output.h>
#include <libexplain/shmat.h>

Go to the source code of this file.

Functions
static void *	shmat (int shmid, const void *shmaddr, int shmflg)
void *	explain_shmat_or_die (int shmid, const void *shmaddr, int shmflg)
void *	explain_shmat_on_error (int shmid, const void *shmaddr, int shmflg)

---

Function Documentation

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

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.

Parameters:

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.

Returns:

The value returned by the wrapped shmat(2) system call.

Example:

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

 void *result = explain_shmat_on_error(shmid, shmaddr, shmflg);
 if (!result)
 {
     ...cope with error
     ...no need to print error message
 }

Definition at line 56 of file shmat_or_die.c.

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

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).

Parameters:

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.

Returns:

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

Example:

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

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

Definition at line 42 of file shmat_or_die.c.

static void* shmat	(	int	shmid,
		const void *	shmaddr,
		int	shmflg
	)		[static]

Definition at line 29 of file shmat_or_die.c.