libexplain/fgetpos.h File Reference

explain fgetpos(3) errors More...

#include <libexplain/gcc_attributes.h>
#include <libexplain/large_file_support.h>
#include <stdio.h>

Go to the source code of this file.

Functions
void	explain_fgetpos_or_die (FILE *fp, fpos_t *pos)
int	explain_fgetpos_on_error (FILE *fp, fpos_t *pos)
const char *	explain_fgetpos (FILE *fp, fpos_t *pos) LIBEXPLAIN_WARN_UNUSED_RESULT
const char *	explain_errno_fgetpos (int errnum, FILE *fp, fpos_t *pos) LIBEXPLAIN_WARN_UNUSED_RESULT
void	explain_message_fgetpos (char *message, int message_size, FILE *fp, fpos_t *pos)
void	explain_message_errno_fgetpos (char *message, int message_size, int errnum, FILE *fp, fpos_t *pos)

---

Detailed Description

explain fgetpos(3) errors

These functions may be used to obtain explanations for errors returned by the fgetpos(3) system call.

Definition in file fgetpos.h.

---

Function Documentation

const char* explain_errno_fgetpos	(	int	errnum,
		FILE *	fp,
		fpos_t *	pos
	)

The explain_errno_fgetpos function is used to obtain an explanation of an error returned by the fgetpos(3) 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:

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.
fp	The original fp, exactly as passed to the fgetpos(3) system call.
pos	The original pos, exactly as passed to the fgetpos(3) system call.

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

Example:

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

 if (fgetpos(fp, pos) < 0)
 {
     int err = errno;
     fprintf(stderr, "%s\n", explain_errno_fgetpos(err, fp, pos));
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_fgetpos_or_die function.

const char* explain_fgetpos	(	FILE *	fp,
		fpos_t *	pos
	)

The explain_fgetpos function is used to obtain an explanation of an error returned by the fgetpos(3) system call. The least the message will contain is the value of strerror(errno), but usually it will do much better, and indicate the underlying cause in more detail.

The errno global variable will be used to obtain the error value to be decoded.

Parameters:

fp	The original fp, exactly as passed to the fgetpos(3) system call.
pos	The original pos, exactly as passed to the fgetpos(3) system call.

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

Example:

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

 if (fgetpos(fp, pos) < 0)
 {
     fprintf(stderr, "%s\n", explain_fgetpos(fp, pos));
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_fgetpos_or_die function.

int explain_fgetpos_on_error	(	FILE *	fp,
		fpos_t *	pos
	)

The explain_fgetpos_on_error function is used to call the fgetpos(3) system call. On failure an explanation will be printed to stderr, obtained from the explain_fgetpos(3) function.

Parameters:

fp	The fp, exactly as to be passed to the fgetpos(3) system call.
pos	The pos, exactly as to be passed to the fgetpos(3) system call.

Returns:

The value returned by the wrapped fgetpos(3) system call.

Example:

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

 if (explain_fgetpos_on_error(fp, pos) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

void explain_fgetpos_or_die	(	FILE *	fp,
		fpos_t *	pos
	)

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

Parameters:

fp	The fp, exactly as to be passed to the fgetpos(3) system call.
pos	The pos, exactly as to be passed to the fgetpos(3) system call.

Returns:

This function only returns on success, see fgetpos(3) 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:

 explain_fgetpos_or_die(fp, pos);

void explain_message_errno_fgetpos	(	char *	message,
		int	message_size,
		int	errnum,
		FILE *	fp,
		fpos_t *	pos
	)

The explain_message_errno_fgetpos function is used to obtain an explanation of an error returned by the fgetpos(3) 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:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
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.
fp	The original fp, exactly as passed to the fgetpos(3) system call.
pos	The original pos, exactly as passed to the fgetpos(3) system call.

Example:

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

 if (fgetpos(fp, pos) < 0)
 {
     int err = errno;
     char message[3000];
     explain_message_errno_fgetpos(message, sizeof(message), err, fp, pos);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_fgetpos_or_die function.

void explain_message_fgetpos	(	char *	message,
		int	message_size,
		FILE *	fp,
		fpos_t *	pos
	)

The explain_message_fgetpos function is used to obtain an explanation of an error returned by the fgetpos(3) 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.

The errno global variable will be used to obtain the error value to be decoded.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
fp	The original fp, exactly as passed to the fgetpos(3) system call.
pos	The original pos, exactly as passed to the fgetpos(3) system call.

Example:

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

 if (fgetpos(fp, pos) < 0)
 {
     char message[3000];
     explain_message_fgetpos(message, sizeof(message), fp, pos);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_fgetpos_or_die function.