GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  EXPLAIN_FCLOSE (3)

NAME

explain_fclose - explain fclose(3) errors

CONTENTS

Synopsis
Description
Copyright
Author

SYNOPSIS

#include <libexplain/fclose.h>
const char *explain_fclose(FILE *fp);
const char *explain_errno_fclose(int errnum, FILE *fp);
void explain_message_fclose(char *message, int message_size, FILE *fp);
void explain_message_errno_fclose(char *message, int message_size, int errnum, FILE *fp);

DESCRIPTION

These functions may be used to obtain explanations of I]fclose(3) errors.

    explain_fclose

const char *explain_fclose(FILE * fp);

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

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

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

if (fclose(fp))
{
    fprintf(stderr, "%s\n", explain_fclose(fp));
    exit(EXIT_FAILURE);
}

I]fp The original fp, exactly as passed to the I]fclose(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.
B]Note: This function is B]not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

B]Note: This function may be of little diagnostic value, because libc may have destroyed any useful context, leaving nothing for libexplain to work with (this is true of glibc in particular). For files that are open for writing, you will obtain more useful information by first calling I]fflush(3), as in the following example

if (fflush(fp))
{
    fprintf(stderr, "%s\n", explain_fflush(fp));
    exit(EXIT_FAILURE);
}
if (fclose(fp))
{
    fprintf(stderr, "%s\n", explain_fclose(fp));
    exit(EXIT_FAILURE);
}

    explain_errno_fclose

const char *explain_errno_fclose(int errnum, FILE * fp);

The explain_errno_fclose function is used to obtain an explanation of an error returned by the I]fclose(3) function. The least the message will contain is the value of CW]strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

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

if (fclose(fp))
{
    int err = errno;
    fprintf(stderr, "%s\n", explain_errno_fclose(err, fp));
    exit(EXIT_FAILURE);
}

I]errnum The error value to be decoded, usually obtained from the I]errno global variable just before this function is called. This is necessary if you need to call B]any code between the system call to be explained and this function, because many libc functions will alter the value of I]errno.
I]fp The original fp, exactly as passed to the I]fclose(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.
B]Note: This function is B]not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

B]Note: This function may be of little diagnostic value, because libc may have destroyed any useful context, leaving nothing for libexplain to work with (this is true of glibc in particular). For files that are open for writing, you will obtain more useful information by first calling I]fflush(3), as in the following example

if (fflush(fp))
{
    int err = errno;
    fprintf(stderr, "%s\n", explain_errno_fflush(err, fp));
    exit(EXIT_FAILURE);
}
if (fclose(fp))
{
    int err = errno;
    fprintf(stderr, "%s\n", explain_errno_fclose(err, fp));
    exit(EXIT_FAILURE);
}

    explain_message_fclose

void explain_message_fclose(char *message, int message_size, FILE *fp);

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

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

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

if (fclose(fp))
{
    char message[3000];
    explain_message_fclose(message, sizeof(message), fp);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

I]message
  The location in which to store the returned message. Because a message return buffer has been supplied, this function is thread safe.
I]message_size
  The size in bytes of the location in which to store the returned message.
I]fp The original fp, exactly as passed to the I]fclose(3) system call.
B]Note: This function may be of little diagnostic value, because libc may have destroyed any useful context, leaving nothing for libexplain to work with (this is true of glibc in particular). For files that are open for writing, you will obtain more useful information by first calling I]fflush(3), as in the following example
if (fflush(fp))
{
    char message[3000];
    explain_message_fflush(message, sizeof(message), fp);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}
if (fclose(fp))
{
    char message[3000];
    explain_message_fclose(message, sizeof(message), fp);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

    explain_message_errno_fclose

void explain_message_errno_fclose(char *message, int message_size, int errnum, FILE *fp);

The explain_message_errno_fclose function is used to obtain an explanation of an error returned by the I]fclose(3) function. The least the message will contain is the value of CW]strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

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

if (fclose(fp))
{
    int err = errno;
    char message[3000];
    explain_message_errno_fclose(message, sizeof(message),
        err, fp);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

I]message
  The location in which to store the returned message. Because a message return buffer has been supplied, this function is thread safe.
I]message_size
  The size in bytes of the location in which to store the returned message.
I]errnum The error value to be decoded, usually obtained from the I]errno global variable just before this function is called. This is necessary if you need to call B]any code between the system call to be explained and this function, because many libc functions will alter the value of I]errno.
I]fp The original fp, exactly as passed to the I]fclose(3) system call.
B]Note: This function may be of little diagnostic value, because libc may have destroyed any useful context, leaving nothing for libexplain to work with (this is true of glibc in particular). For files that are open for writing, you will obtain more useful information by first calling I]fflush(3), as in the following example
if (fflush(fp))
{
    int err = errno;
    char message[3000];
    explain_message_errno_fflush(message, sizeof(message),
        err, fp);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}
if (fclose(fp))
{
    int err = errno;
    char message[3000];
    explain_message_errno_fclose(message, sizeof(message),
        err, fp);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

COPYRIGHT

libexplain version 1.3
Copyright © 2008 Peter Miller

AUTHOR

Written by Peter Miller <pmiller@opensource.org.au>
Search for    or go to Top of page |  Section 3 |  Main Index


EXPLAIN_FCLOSE (3) -->

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.