Provided by: explain_0.52.D002-1_amd64 bug

NAME

       explain_mkstemp - explain mkstemp(3) errors

SYNOPSIS

       #include <libexplain/mkstemp.h>
       const char *explain_mkstemp(char *templat);
       const char *explain_errno_mkstemp(int errnum, char *templat);
       void explain_message_mkstemp(char *message, int message_size, char *templat);
       void explain_message_errno_mkstemp(char *message, int message_size, int errnum, char *templat);

DESCRIPTION

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

   explain_mkstemp
       const char *explain_mkstemp(char *templat);

       The  explain_mkstemp  function  is  used  to obtain an explanation of an error returned by the mkstemp(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 mkstemp(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 = mkstemp(templat);
              if (result < 0)
              {
                  fprintf(stderr, "%s\n", explain_mkstemp(templat));
                  exit(EXIT_FAILURE);
              }

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

   explain_errno_mkstemp
       const char *explain_errno_mkstemp(int errnum, char *templat);

       The explain_errno_mkstemp function is used  to  obtain  an  explanation  of  an  error  returned  by  the
       mkstemp(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 mkstemp(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 = mkstemp(templat);
              if (result < 0)
              {
                  int err = errno;
                  fprintf(stderr, "%s\n", explain_errno_mkstemp(err, templat));
                  exit(EXIT_FAILURE);
              }

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

   explain_message_mkstemp
       void explain_message_mkstemp(char *message, int message_size, char *templat);

       The  explain_message_mkstemp  function  is  used  to  obtain  an  explanation of an error returned by the
       mkstemp(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 mkstemp(3) system call.

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

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

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

       The explain_message_errno_mkstemp function is used to obtain an explanation of an error returned  by  the
       mkstemp(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 mkstemp(3) system call.

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

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

SEE ALSO

       mkstemp(3)
               create a unique temporary file

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

COPYRIGHT

       libexplain version 0.52
       Copyright (C) 2009 Peter Miller

                                                                                              explain_mkstemp(3)