explain_strcoll(3)                                          explain_strcoll(3)



NNAAMMEE
       explain_strcoll - explain _s_t_r_c_o_l_l(3) errors

SSYYNNOOPPSSIISS
       #include <libexplain/strcoll.h>
       const char *explain_strcoll(const char *s1, const char *s2);
       const char *explain_errno_strcoll(int errnum, const char *s1, const
       char *s2);
       void explain_message_strcoll(char *message, int message_size, const
       char *s1, const char *s2);
       void explain_message_errno_strcoll(char *message, int message_size, int
       errnum, const char *s1, const char *s2);

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 _s_t_r_c_o_l_l(3) system call.

   eexxppllaaiinn__ssttrrccoollll
       const char *explain_strcoll(const char *s1, const char *s2);

       The  eexxppllaaiinn__ssttrrccoollll  function  is  used to obtain an explanation of an
       error returned by the _s_t_r_c_o_l_l(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 _e_r_r_n_o global variable will be used to obtain the error value to  be
       decoded.

       _s_1      The  original  s1,  exactly  as passed to the _s_t_r_c_o_l_l(3) system
               call.

       _s_2      The original s2, exactly as passed  to  the  _s_t_r_c_o_l_l(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.

       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:
              errno = 0;
              int result = strcoll(s1, s2);
              if (result < 0 && errno != 0)
              {
                  fprintf(stderr, "%s\n", explain_strcoll(s1, s2));
                  exit(EXIT_FAILURE);
              }

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

   eexxppllaaiinn__eerrrrnnoo__ssttrrccoollll
       const char *explain_errno_strcoll(int errnum, const char *s1, const
       char *s2);

       The  eexxppllaaiinn__eerrrrnnoo__ssttrrccoollll function is used to obtain an explanation of
       an error returned by the _s_t_r_c_o_l_l(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.

       _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.

       _s_1      The original s1, exactly as passed  to  the  _s_t_r_c_o_l_l(3)  system
               call.

       _s_2      The  original  s2,  exactly  as passed to the _s_t_r_c_o_l_l(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.

       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:
              errno = 0;
              int result = strcoll(s1, s2);
              if (result < 0 && errno != 0)
              {
                  int err = errno;
                  fprintf(stderr, "%s\n", explain_errno_strcoll(err, s1, s2));
                  exit(EXIT_FAILURE);
              }

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

   eexxppllaaiinn__mmeessssaaggee__ssttrrccoollll
       void explain_message_strcoll(char *message, int message_size, const
       char *s1, const char *s2);

       The eexxppllaaiinn__mmeessssaaggee__ssttrrccoollll function is used to obtain  an  explanation
       of  an error returned by the _s_t_r_c_o_l_l(3) system call. The least the mes-
       sage 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.

       _s_1      The  original  s1,  exactly  as passed to the _s_t_r_c_o_l_l(3) system
               call.

       _s_2      The original s2, exactly as passed  to  the  _s_t_r_c_o_l_l(3)  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:
              errno = 0;
              int result = strcoll(s1, s2);
              if (result < 0 && errno != 0)
              {
                  char message[3000];
                  explain_message_strcoll(message, sizeof(message), s1, s2);
                  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___s_t_r_-
       _c_o_l_l___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__ssttrrccoollll
       void explain_message_errno_strcoll(char *message, int message_size, int
       errnum, const char *s1, const char *s2);

       The eexxppllaaiinn__mmeessssaaggee__eerrrrnnoo__ssttrrccoollll function is used to obtain an  expla-
       nation  of  an  error returned by the _s_t_r_c_o_l_l(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.

       _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.

       _s_1      The  original  s1,  exactly  as passed to the _s_t_r_c_o_l_l(3) system
               call.

       _s_2      The original s2, exactly as passed  to  the  _s_t_r_c_o_l_l(3)  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:
              errno = 0;
              int result = strcoll(s1, s2);
              if (result < 0 && errno != 0)
              {
                  int err = errno;
                  char message[3000];
                  explain_message_errno_strcoll(message, sizeof(message), err,
                  s1, s2);
                  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___s_t_r_-
       _c_o_l_l___o_r___d_i_e(3) function.

SSEEEE AALLSSOO
       _s_t_r_c_o_l_l(3)
               compare two strings using the current locale

       _e_x_p_l_a_i_n___s_t_r_c_o_l_l___o_r___d_i_e(3)
               compare two strings using the current locale and report errors

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



                                                            explain_strcoll(3)
