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_READLINK (3)

NAME

explain_readlink - explain readlink(2) errors

CONTENTS

Synopsis
Description
See Also
Copyright

SYNOPSIS

#include <libexplain/readlink.h>

const char *explain_readlink(const char *pathname, char *data, size_t data_size);
const char *explain_errno_readlink(int errnum, const char *pathname, char *data, size_t data_size);
void explain_message_readlink(char *message, int message_size, const char *pathname, char *data, size_t data_size);
void explain_message_errno_readlink(char *message, int message_size, int errnum, const char *pathname, char *data, size_t data_size);

DESCRIPTION

These functions may be used to obtain explanations for errors returned by the I]readlink(2) system call.

    explain_readlink

const char *explain_readlink(const char *pathname, char *data, size_t data_size);

The B]explain_readlink function is used to obtain an explanation of an error returned by the I]readlink(2) system call. 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 (readlink(pathname, data, data_size) < 0)
{
    fprintf(stderr, "%s\n", explain_readlink(pathname, data, data_size));
    exit(EXIT_FAILURE);
}

I]pathname
  The original pathname, exactly as passed to the I]readlink(2) system call.
I]data The original data, exactly as passed to the I]readlink(2) system call.
I]data_size
  The original data_size, exactly as passed to the I]readlink(2) 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.

    explain_errno_readlink

const char *explain_errno_readlink(int errnum, const char *pathname, char *data, size_t data_size);

The B]explain_errno_readlink function is used to obtain an explanation of an error returned by the I]readlink(2) system call. 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 (readlink(pathname, data, data_size) < 0)
{
    int err = errno;
    fprintf(stderr, "%s\n", explain_errno_readlink(err, pathname, data,
        data_size));
    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]pathname
  The original pathname, exactly as passed to the I]readlink(2) system call.
I]data The original data, exactly as passed to the I]readlink(2) system call.
I]data_size
  The original data_size, exactly as passed to the I]readlink(2) 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.

    explain_message_readlink

void explain_message_readlink(char *message, int message_size, const char *pathname, char *data, size_t data_size);

The B]explain_message_readlink function may be used to obtain an explanation of an error returned by the I]readlink(2) system call. 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 (readlink(pathname, data, data_size) < 0)
{
    char message[3000];
    explain_message_readlink(message, sizeof(message), pathname, data,
        data_size);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

I]message
  The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
I]message_size
  The size in bytes of the location in which to store the returned message.
I]pathname
  The original pathname, exactly as passed to the I]readlink(2) system call.
I]data The original data, exactly as passed to the I]readlink(2) system call.
I]data_size
  The original data_size, exactly as passed to the I]readlink(2) system call.

    explain_message_errno_readlink

void explain_message_errno_readlink(char *message, int message_size, int errnum, const char *pathname, char *data, size_t data_size);

The B]explain_message_errno_readlink function may be used to obtain an explanation of an error returned by the I]readlink(2) system call. 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 (readlink(pathname, data, data_size) < 0)
{
    int err = errno;
    char message[3000];
    explain_message_errno_readlink(message, sizeof(message), err, pathname,
        data, data_size);
    fprintf(stderr, "%s\n", message);
    exit(EXIT_FAILURE);
}

I]message
  The location in which to store the returned message. If a suitable message return buffer is 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]pathname
  The original pathname, exactly as passed to the I]readlink(2) system call.
I]data The original data, exactly as passed to the I]readlink(2) system call.
I]data_size
  The original data_size, exactly as passed to the I]readlink(2) system call.

SEE ALSO

I]readlink(2)
  blah blah blah
I]explain_readlink_or_die(3)
  blah blah blah and report errors

COPYRIGHT

libexplain version 1.3
Copyright © 2008 Peter Miller
Search for    or go to Top of page |  Section 3 |  Main Index


EXPLAIN_READLINK (3) -->

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