libexplain/buffer/errno/rename.h File Reference

Go to the source code of this file.

Functions
void	explain_buffer_errno_rename (struct explain_string_buffer_t *sb, int errnum, const char *oldpath, const char *newpath)

---

Function Documentation

void explain_buffer_errno_rename	(	struct explain_string_buffer_t *	sb,
		int	errnum,
		const char *	oldpath,
		const char *	newpath
	)

The explain_buffer_errno_rename function is used to obtain an explanation of an error returned by the rename(2) function. 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 in which the message is being constructed. If a safe buffer s specified, this function is thread safe.
errnum	The error value to be decoded, usually obtain 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.
oldpath	The original oldpath, exactly has passed to the rename(2) system call.
newpath	The original newpath, exactly has passed to the rename(2) system call.

Definition at line 481 of file rename.c.