Man Linux: Main Page and Category List

NAME

       explain_ftime - explain ftime(3) errors

SYNOPSIS

       #include <libexplain/ftime.h>
       const char *explain_ftime(struct timeb *tp);
       const char *explain_errno_ftime(int errnum, struct timeb *tp);
       void explain_message_ftime(char *message, int message_size, struct
       timeb *tp);
       void explain_message_errno_ftime(char *message, int message_size, int
       errnum, struct timeb *tp);

DESCRIPTION

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

   explain_ftime
       const char *explain_ftime(struct timeb *tp);

       The explain_ftime function is used to obtain an explanation of an error
       returned  by  the  ftime(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.

       tp      The original tp, exactly as passed to the ftime(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 (ftime(tp) < 0)
              {
                  fprintf(stderr, "%s\n", explain_ftime(tp));
                  exit(EXIT_FAILURE);
              }

       The   above   code   example   is   available   pre-packaged   as   the
       explain_ftime_or_die(3) function.

   explain_errno_ftime
       const char *explain_errno_ftime(int errnum, struct timeb *tp);

       The explain_errno_ftime function is used to obtain an explanation of an
       error  returned by the ftime(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.

       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.

       tp      The original tp, exactly as passed to the ftime(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 (ftime(tp) < 0)
              {
                  int err = errno;
                  fprintf(stderr, "%s\n", explain_errno_ftime(err, tp));
                  exit(EXIT_FAILURE);
              }

       The   above   code   example   is   available   pre-packaged   as   the
       explain_ftime_or_die(3) function.

   explain_message_ftime
       void explain_message_ftime(char *message, int message_size, struct
       timeb *tp);

       The explain_message_ftime function is used to obtain an explanation  of
       an  error  returned  by the ftime(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.

       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.

       tp      The original tp, exactly as passed to the ftime(3) system call.

       Example: This function is intended to be used in a fashion  similar  to
       the following example:
              if (ftime(tp) < 0)
              {
                  char message[3000];
                  explain_message_ftime(message, sizeof(message), tp);
                  fprintf(stderr, "%s\n", message);
                  exit(EXIT_FAILURE);
              }

       The   above   code   example   is   available   pre-packaged   as   the
       explain_ftime_or_die(3) function.

   explain_message_errno_ftime
       void explain_message_errno_ftime(char *message, int message_size, int
       errnum, struct timeb *tp);

       The   explain_message_errno_ftime   function   is  used  to  obtain  an
       explanation of an error returned by the ftime(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.

       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.

       tp      The original tp, exactly as passed to the ftime(3) system call.

       Example:  This  function is intended to be used in a fashion similar to
       the following example:
              if (ftime(tp) < 0)
              {
                  int err = errno;
                  char message[3000];
                  explain_message_errno_ftime(message, sizeof(message), err,
                  tp);
                  fprintf(stderr, "%s\n", message);
                  exit(EXIT_FAILURE);
              }

       The   above   code   example   is   available   pre-packaged   as   the
       explain_ftime_or_die(3) function.

SEE ALSO

       ftime(3)
               return date and time

       explain_ftime_or_die(3)
               return date and time and report errors

COPYRIGHT

       libexplain version 0.19
       Copyright (C) 2009 Peter Miller

                                                              explain_ftime(3)