libexplain/buffer/errno/shmat.h File Reference

#include <libexplain/ac/sys/shm.h>
#include <libexplain/string_buffer.h>

Go to the source code of this file.

Functions
void	explain_buffer_errno_shmat (explain_string_buffer_t *sb, int errnum, int shmid, const void *shmaddr, int shmflg)
void	explain_buffer_errno_shmat_explanation (explain_string_buffer_t *sb, int errnum, const char *syscall_name, int shmid, const void *shmaddr, int shmflg)

---

Function Documentation

void explain_buffer_errno_shmat	(	explain_string_buffer_t *	sb,
		int	errnum,
		int	shmid,
		const void *	shmaddr,
		int	shmflg
	)

The explain_buffer_errno_shmat function is used to obtain an explanation of an error returned by the shmat(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:

sb	The string buffer to print the message into. If a suitable buffer is specified, this function is thread safe.
errnum	The error value to be decoded, usually obtained 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.
shmid	The original shmid, exactly as passed to the shmat(2) system call.
shmaddr	The original shmaddr, exactly as passed to the shmat(2) system call.
shmflg	The original shmflg, exactly as passed to the shmat(2) system call.

Definition at line 274 of file shmat.c.

void explain_buffer_errno_shmat_explanation	(	explain_string_buffer_t *	sb,
		int	errnum,
		const char *	syscall_name,
		int	shmid,
		const void *	shmaddr,
		int	shmflg
	)

The explain_buffer_errno_shmat_explanation function is used to obtain the explanation (the part after "because") of an error returned by the shmat(2) system call (and similar).

Parameters:

sb	The string buffer to print the message into. If a suitable buffer is specified, this function is thread safe.
errnum	The error value to be decoded, usually obtained 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_name	The name of the offending system call.
shmid	The original shmid, exactly as passed to the shmat(2) system call.
shmaddr	The original shmaddr, exactly as passed to the shmat(2) system call.
shmflg	The original shmflg, exactly as passed to the shmat(2) system call.

Definition at line 125 of file shmat.c.