explain_linkat(3)                                            explain_linkat(3)



NNAAMMEE
       explain_linkat - explain _l_i_n_k_a_t(2) errors

SSYYNNOOPPSSIISS
       #include <libexplain/linkat.h>
       const char *explain_linkat(int old_fildes, const char *old_path, int
       new_fildes, const char *new_path, int flags);
       const char *explain_errno_linkat(int errnum, int old_fildes, const char
       *old_path, int new_fildes, const char *new_path, int flags);
       void explain_message_linkat(char *message, int message_size, int
       old_fildes, const char *old_path, int new_fildes, const char *new_path,
       int flags);
       void explain_message_errno_linkat(char *message, int message_size, int
       errnum, int old_fildes, const char *old_path, int new_fildes, const
       char *new_path, int flags);

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 _l_i_n_k_a_t(2) system call.

   eexxppllaaiinn__lliinnkkaatt
       const char *explain_linkat(int old_fildes, const char *old_path, int
       new_fildes, const char *new_path, int flags);

       The  eexxppllaaiinn__lliinnkkaatt  function  is  used  to obtain an explanation of an
       error returned by the _l_i_n_k_a_t(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.

       _o_l_d___f_i_l_d_e_s
               The  original  old_fildes,  exactly  as passed to the _l_i_n_k_a_t(2)
               system call.

       _o_l_d___p_a_t_h
               The original old_path, exactly as passed to the _l_i_n_k_a_t(2)  sys-
               tem call.

       _n_e_w___f_i_l_d_e_s
               The  original  new_fildes,  exactly  as passed to the _l_i_n_k_a_t(2)
               system call.

       _n_e_w___p_a_t_h
               The original new_path, exactly as passed to the _l_i_n_k_a_t(2)  sys-
               tem call.

       _f_l_a_g_s   The  original  flags, exactly as passed to the _l_i_n_k_a_t(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.

       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:
              if (linkat(old_fildes, old_path, new_fildes, new_path, flags) <
              0)
              {
                  fprintf(stderr, "%s\n", explain_linkat(old_fildes, old_path,
                  new_fildes, new_path, flags));
                  exit(EXIT_FAILURE);
              }

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

   eexxppllaaiinn__eerrrrnnoo__lliinnkkaatt
       const char *explain_errno_linkat(int errnum, int old_fildes, const char
       *old_path, int new_fildes, const char *new_path, int flags);

       The eexxppllaaiinn__eerrrrnnoo__lliinnkkaatt function is used to obtain an  explanation  of
       an  error  returned by the _l_i_n_k_a_t(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.

       _o_l_d___f_i_l_d_e_s
               The  original  old_fildes,  exactly  as passed to the _l_i_n_k_a_t(2)
               system call.

       _o_l_d___p_a_t_h
               The original old_path, exactly as passed to the _l_i_n_k_a_t(2)  sys-
               tem call.

       _n_e_w___f_i_l_d_e_s
               The  original  new_fildes,  exactly  as passed to the _l_i_n_k_a_t(2)
               system call.

       _n_e_w___p_a_t_h
               The original new_path, exactly as passed to the _l_i_n_k_a_t(2)  sys-
               tem call.

       _f_l_a_g_s   The  original  flags, exactly as passed to the _l_i_n_k_a_t(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.

       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:
              if (linkat(old_fildes, old_path, new_fildes, new_path, flags) <
              0)
              {
                  int err = errno;
                  fprintf(stderr, "%s\n", explain_errno_linkat(err,
                  old_fildes, old_path, new_fildes, new_path, flags));
                  exit(EXIT_FAILURE);
              }

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

   eexxppllaaiinn__mmeessssaaggee__lliinnkkaatt
       void explain_message_linkat(char *message, int message_size, int
       old_fildes, const char *old_path, int new_fildes, const char *new_path,
       int flags);

       The eexxppllaaiinn__mmeessssaaggee__lliinnkkaatt function is used to obtain an explanation of
       an error returned by the _l_i_n_k_a_t(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.

       _o_l_d___f_i_l_d_e_s
               The original old_fildes, exactly as  passed  to  the  _l_i_n_k_a_t(2)
               system call.

       _o_l_d___p_a_t_h
               The  original old_path, exactly as passed to the _l_i_n_k_a_t(2) sys-
               tem call.

       _n_e_w___f_i_l_d_e_s
               The original new_fildes, exactly as  passed  to  the  _l_i_n_k_a_t(2)
               system call.

       _n_e_w___p_a_t_h
               The  original new_path, exactly as passed to the _l_i_n_k_a_t(2) sys-
               tem call.

       _f_l_a_g_s   The original flags, exactly as passed to the  _l_i_n_k_a_t(2)  system
               call.

       EExxaammppllee::  This  function is intended to be used in a fashion similar to
       the following example:
              if (linkat(old_fildes, old_path, new_fildes, new_path, flags) <
              0)
              {
                  char message[3000];
                  explain_message_linkat(message, sizeof(message), old_fildes,
                  old_path, new_fildes, new_path, flags);
                  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___l_i_n_k_a_t___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__lliinnkkaatt
       void explain_message_errno_linkat(char *message, int message_size, int
       errnum, int old_fildes, const char *old_path, int new_fildes, const
       char *new_path, int flags);

       The eexxppllaaiinn__mmeessssaaggee__eerrrrnnoo__lliinnkkaatt function is used to obtain an explana-
       tion of an error returned by the _l_i_n_k_a_t(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.

       _o_l_d___f_i_l_d_e_s
               The  original  old_fildes,  exactly  as passed to the _l_i_n_k_a_t(2)
               system call.

       _o_l_d___p_a_t_h
               The original old_path, exactly as passed to the _l_i_n_k_a_t(2)  sys-
               tem call.

       _n_e_w___f_i_l_d_e_s
               The  original  new_fildes,  exactly  as passed to the _l_i_n_k_a_t(2)
               system call.

       _n_e_w___p_a_t_h
               The original new_path, exactly as passed to the _l_i_n_k_a_t(2)  sys-
               tem call.

       _f_l_a_g_s   The  original  flags, exactly as passed to the _l_i_n_k_a_t(2) system
               call.

       EExxaammppllee:: This function is intended to be used in a fashion  similar  to
       the following example:
              if (linkat(old_fildes, old_path, new_fildes, new_path, flags) <
              0)
              {
                  int err = errno;
                  char message[3000];
                  explain_message_errno_linkat(message, sizeof(message), err,
                  old_fildes, old_path, new_fildes, new_path, flags);
                  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___l_i_n_k_a_t___o_r___d_i_e(3) function.

SSEEEE AALLSSOO
       _l_i_n_k_a_t(2)
               create a file link relative to directory file descriptors

       _e_x_p_l_a_i_n___l_i_n_k_a_t___o_r___d_i_e(3)
               create a file link relative to directory file  descriptors  and
               report errors

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



                                                             explain_linkat(3)
