FreeBSD Manual Pages
explain_utimes(3) Library Functions Manual explain_utimes(3) NAME explain_utimes - explain utimes(2) errors SYNOPSIS #include <libexplain/utimes.h> const char *explain_utimes(const char *pathname, const struct timeval *data); const char *explain_errno_utimes(int errnum, const char *pathname, const struct timeval *data); void explain_message_utimes(char *message, int message_size, const char *pathname, const struct timeval *data); void explain_message_errno_utimes(char *message, int message_size, int errnum, const char *pathname, const struct timeval *data); DESCRIPTION These functions may be used to obtain explanations for errors returned by the utimes(2) system call. explain_utimes const char *explain_utimes(const char *pathname, const struct timeval *data); The explain_utimes function is used to obtain an explanation of an er- ror returned by the utimes(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 errno global variable will be used to obtain the error value to be decoded. pathname The original pathname, exactly as passed to the utimes(2) sys- tem call. data The original data, exactly as passed to the utimes(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. 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: if (utimes(pathname, data) < 0) { fprintf(stderr, "%s\n", explain_utimes(pathname, data)); exit(EXIT_FAILURE); } The above code example is available pre-packaged as the ex- plain_utimes_or_die(3) function. explain_errno_utimes const char *explain_errno_utimes(int errnum, const char *pathname, const struct timeval *data); The explain_errno_utimes function is used to obtain an explanation of an error returned by the utimes(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. 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. pathname The original pathname, exactly as passed to the utimes(2) sys- tem call. data The original data, exactly as passed to the utimes(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. 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: if (utimes(pathname, data) < 0) { int err = errno; fprintf(stderr, "%s\n", explain_errno_utimes(err, pathname, data)); exit(EXIT_FAILURE); } The above code example is available pre-packaged as the ex- plain_utimes_or_die(3) function. explain_message_utimes void explain_message_utimes(char *message, int message_size, const char *pathname, const struct timeval *data); The explain_message_utimes function is used to obtain an explanation of an error returned by the utimes(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 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 suit- able message return buffer is supplied, this function is thread safe. message_size The size in bytes of the location in which to store the re- turned message. pathname The original pathname, exactly as passed to the utimes(2) sys- tem call. data The original data, exactly as passed to the utimes(2) system call. Example: This function is intended to be used in a fashion similar to the following example: if (utimes(pathname, data) < 0) { char message[3000]; explain_message_utimes(message, sizeof(message), pathname, data); fprintf(stderr, "%s\n", message); exit(EXIT_FAILURE); } The above code example is available pre-packaged as the ex- plain_utimes_or_die(3) function. explain_message_errno_utimes void explain_message_errno_utimes(char *message, int message_size, int errnum, const char *pathname, const struct timeval *data); The explain_message_errno_utimes function is used to obtain an explana- tion of an error returned by the utimes(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. message The location in which to store the returned message. If a suit- able message return buffer is supplied, this function is thread safe. message_size The size in bytes of the location in which to store the re- turned 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. pathname The original pathname, exactly as passed to the utimes(2) sys- tem call. data The original data, exactly as passed to the utimes(2) system call. Example: This function is intended to be used in a fashion similar to the following example: if (utimes(pathname, data) < 0) { int err = errno; char message[3000]; explain_message_errno_utimes(message, sizeof(message), err, pathname, data); fprintf(stderr, "%s\n", message); exit(EXIT_FAILURE); } The above code example is available pre-packaged as the ex- plain_utimes_or_die(3) function. SEE ALSO utimes(2) change file last access and modification times explain_utimes_or_die(3) change file last access and modification times and report er- rors COPYRIGHT libexplain version 1.3 Copyright (C) 2010 Peter Miller explain_utimes(3)
NAME | SYNOPSIS | DESCRIPTION | SEE ALSO | COPYRIGHT
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=explain_utimes&sektion=3&manpath=FreeBSD+Ports+15.0.quarterly>