Provided by: libexplain-dev_1.4.D001-13_amd64 bug

NAME

       explain_mkostemp - explain mkostemp(3) errors

SYNOPSIS

       #include <libexplain/mkostemp.h>
       const char *explain_mkostemp(char *templat, int flags);
       const char *explain_errno_mkostemp(int errnum, char *templat, int flags);
       void explain_message_mkostemp(char *message, int message_size, char *templat, int flags);
       void explain_message_errno_mkostemp(char *message, int message_size, int errnum, char
       *templat, int flags);

DESCRIPTION

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

   explain_mkostemp
       const char *explain_mkostemp(char *templat, int flags);

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

       templat The original template, exactly as passed to the mkostemp(3) system call.

       flags   The original flags, exactly as passed to the mkostemp(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:
              int result = mkostemp(templat, flags);
              if (result < 0)
              {
                  fprintf(stderr, "%s\n", explain_mkostemp(templat, flags));
                  exit(EXIT_FAILURE);
              }

       The  above  code  example  is  available  pre‐packaged  as  the explain_mkostemp_or_die(3)
       function.

   explain_errno_mkostemp
       const char *explain_errno_mkostemp(int errnum, char *templat, int flags);

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

       templat The original template, exactly as passed to the mkostemp(3) system call.

       flags   The original flags, exactly as passed to the mkostemp(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:
              int result = mkostemp(templat, flags);
              if (result < 0)
              {
                  int err = errno;
                  fprintf(stderr, "%s\n", explain_errno_mkostemp(err, templat, flags));
                  exit(EXIT_FAILURE);
              }

       The  above  code  example  is  available  pre‐packaged  as  the explain_mkostemp_or_die(3)
       function.

   explain_message_mkostemp
       void explain_message_mkostemp(char *message, int message_size, char *templat, int flags);

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

       templat The original template, exactly as passed to the mkostemp(3) system call.

       flags   The original flags, exactly as passed to the mkostemp(3) system call.

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

       The  above  code  example  is  available  pre‐packaged  as  the explain_mkostemp_or_die(3)
       function.

   explain_message_errno_mkostemp
       void explain_message_errno_mkostemp(char *message, int message_size, int errnum, char
       *templat, int flags);

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

       templat The original template, exactly as passed to the mkostemp(3) system call.

       flags   The original flags, exactly as passed to the mkostemp(3) system call.

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

       The  above  code  example  is  available  pre‐packaged  as  the explain_mkostemp_or_die(3)
       function.

SEE ALSO

       mkostemp(3)
               create a unique temporary file

       explain_mkostemp_or_die(3)
               create a unique temporary file and report errors

COPYRIGHT

       libexplain version 1.4
       Copyright (C) 2009 Peter Miller

                                                                              explain_mkostemp(3)