explain_writev(3)                                            explain_writev(3)



NNAAMMEE
       explain_writev - explain writev(2) errors

SSYYNNOOPPSSIISS
       #include <libexplain/writev.h>
       const char *explain_writev(int fildes, const struct iovec *data, int
       data_size);
       const char *explain_errno_writev(int errnum, int fildes, const struct
       iovec *data, int data_size);
       void explain_message_writev(char *message, int message_size, int
       fildes, const struct iovec *data, int data_size);
       void explain_message_errno_writev(char *message, int message_size, int
       errnum, int fildes, const struct iovec *data, int data_size);

DDEESSCCRRIIPPTTIIOONN
       These  functions may be used to obtain explanations for errors returned
       by the _w_r_i_t_e_v(2) system call.

   eexxppllaaiinn__wwrriitteevv
       const char *explain_writev(int fildes, const struct iovec *data, int
       data_size);

       The  eexxppllaaiinn__wwrriitteevv  function  is  used  to obtain an explanation of an
       error returned by the _w_r_i_t_e_v(2) 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 _e_r_r_n_o global variable will be used to obtain the error value to  be
       decoded.

       _f_i_l_d_e_s  The  original fildes, exactly as passed to the _w_r_i_t_e_v(2) system
               call.

       _d_a_t_a    The original data, exactly as passed to  the  _w_r_i_t_e_v(2)  system
               call.

       _d_a_t_a___s_i_z_e
               The original data_size, exactly as passed to the _w_r_i_t_e_v(2) sys-
               tem 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.

       NNoottee:: This function is nnoott thread safe, because it shares a return buf-
       fer across all threads, and many other functions in this library.

       EExxaammppllee::  This  function is intended to be used in a fashion similar to
       the following example:
              ssize_t result = writev(fildes, data, data_size);
              if (result < 0)
              {
                  fprintf(stderr, "%s\n", explain_writev(fildes, data,
                  data_size));
                  exit(EXIT_FAILURE);
              }

       The   above   code   example   is   available   pre-packaged   as   the
       _e_x_p_l_a_i_n___w_r_i_t_e_v___o_r___d_i_e(3) function.

   eexxppllaaiinn__eerrrrnnoo__wwrriitteevv
       const char *explain_errno_writev(int errnum, int fildes, const struct
       iovec *data, int data_size);

       The  eexxppllaaiinn__eerrrrnnoo__wwrriitteevv  function is used to obtain an explanation of
       an error returned by the _w_r_i_t_e_v(2) 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.

       _e_r_r_n_u_m  The error value to be decoded, usually obtained from the  _e_r_r_n_o
               global  variable  just  before this function is called. This is
               necessary if you need to call aannyy code between the system  call
               to  be explained and this function, because many libc functions
               will alter the value of _e_r_r_n_o.

       _f_i_l_d_e_s  The original fildes, exactly as passed to the _w_r_i_t_e_v(2)  system
               call.

       _d_a_t_a    The  original  data,  exactly as passed to the _w_r_i_t_e_v(2) system
               call.

       _d_a_t_a___s_i_z_e
               The original data_size, exactly as passed to the _w_r_i_t_e_v(2) sys-
               tem 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.

       NNoottee:: This function is nnoott thread safe, because it shares a return buf-
       fer across all threads, and many other functions in this library.

       EExxaammppllee:: This function is intended to be used in a fashion  similar  to
       the following example:
              ssize_t result = writev(fildes, data, data_size);
              if (result < 0)
              {
                  int err = errno;
                  fprintf(stderr, "%s\n", explain_errno_writev(err, fildes,
                  data, data_size));
                  exit(EXIT_FAILURE);
              }

       The   above   code   example   is   available   pre-packaged   as   the
       _e_x_p_l_a_i_n___w_r_i_t_e_v___o_r___d_i_e(3) function.

   eexxppllaaiinn__mmeessssaaggee__wwrriitteevv
       void explain_message_writev(char *message, int message_size, int
       fildes, const struct iovec *data, int data_size);

       The eexxppllaaiinn__mmeessssaaggee__wwrriitteevv function is used to obtain an explanation of
       an  error  returned by the _w_r_i_t_e_v(2) 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  _e_r_r_n_o global variable will be used to obtain the error value to be
       decoded.

       _m_e_s_s_a_g_e The location in which to store the returned message. If a suit-
               able message return buffer is supplied, this function is thread
               safe.

       _m_e_s_s_a_g_e___s_i_z_e
               The size in bytes  of  the  location  in  which  to  store  the
               returned message.

       _f_i_l_d_e_s  The  original fildes, exactly as passed to the _w_r_i_t_e_v(2) system
               call.

       _d_a_t_a    The original data, exactly as passed to  the  _w_r_i_t_e_v(2)  system
               call.

       _d_a_t_a___s_i_z_e
               The original data_size, exactly as passed to the _w_r_i_t_e_v(2) sys-
               tem call.

       EExxaammppllee:: This function is intended to be used in a fashion  similar  to
       the following example:
              ssize_t result = writev(fildes, data, data_size);
              if (result < 0)
              {
                  char message[3000];
                  explain_message_writev(message, sizeof(message), fildes,
                  data, data_size);
                  fprintf(stderr, "%s\n", message);
                  exit(EXIT_FAILURE);
              }

       The   above   code   example   is   available   pre-packaged   as   the
       _e_x_p_l_a_i_n___w_r_i_t_e_v___o_r___d_i_e(3) function.

   eexxppllaaiinn__mmeessssaaggee__eerrrrnnoo__wwrriitteevv
       void explain_message_errno_writev(char *message, int message_size, int
       errnum, int fildes, const struct iovec *data, int data_size);

       The eexxppllaaiinn__mmeessssaaggee__eerrrrnnoo__wwrriitteevv function is used to obtain an explana-
       tion  of  an error returned by the _w_r_i_t_e_v(2) 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.

       _m_e_s_s_a_g_e The location in which to store the returned message. If a suit-
               able message return buffer is supplied, this function is thread
               safe.

       _m_e_s_s_a_g_e___s_i_z_e
               The  size  in  bytes  of  the  location  in  which to store the
               returned message.

       _e_r_r_n_u_m  The error value to be decoded, usually obtained from the  _e_r_r_n_o
               global  variable  just  before this function is called. This is
               necessary if you need to call aannyy code between the system  call
               to  be explained and this function, because many libc functions
               will alter the value of _e_r_r_n_o.

       _f_i_l_d_e_s  The original fildes, exactly as passed to the _w_r_i_t_e_v(2)  system
               call.

       _d_a_t_a    The  original  data,  exactly as passed to the _w_r_i_t_e_v(2) system
               call.

       _d_a_t_a___s_i_z_e
               The original data_size, exactly as passed to the _w_r_i_t_e_v(2) sys-
               tem call.

       EExxaammppllee::  This  function is intended to be used in a fashion similar to
       the following example:
              ssize_t result = writev(fildes, data, data_size);
              if (result < 0)
              {
                  int err = errno;
                  char message[3000];
                  explain_message_errno_writev(message, sizeof(message), err,
                  fildes, data, data_size);
                  fprintf(stderr, "%s\n", message);
                  exit(EXIT_FAILURE);
              }

       The   above   code   example   is   available   pre-packaged   as   the
       _e_x_p_l_a_i_n___w_r_i_t_e_v___o_r___d_i_e(3) function.

SSEEEE AALLSSOO
       _w_r_i_t_e_v(2)
               write data from multiple buffers

       _e_x_p_l_a_i_n___w_r_i_t_e_v___o_r___d_i_e(3)
               write data from multiple buffers and report errors

CCOOPPYYRRIIGGHHTT
       libexplain version 1.4
       Copyright (C) 2009 Peter Miller



                                                             explain_writev(3)
