plucky (3) explain_strndup.3.gz
NAME
explain_strndup - explain strndup(3) errors
SYNOPSIS
#include <libexplain/strndup.h>
const char *explain_strndup(const char *data, size_t data_size);
const char *explain_errno_strndup(int errnum, const char *data, size_t data_size);
void explain_message_strndup(char *message, int message_size, const char *data, size_t data_size);
void explain_message_errno_strndup(char *message, int message_size, int errnum, const char *data, size_t
data_size);
DESCRIPTION
These functions may be used to obtain explanations for errors returned by the strndup(3) system call. explain_strndup const char *explain_strndup(const char *data, size_t data_size); The explain_strndup function is used to obtain an explanation of an error returned by the strndup(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. data The original data, exactly as passed to the strndup(3) system call. data_size The original data_size, exactly as passed to the strndup(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: char *result = strndup(data, data_size); if (!result) { fprintf(stderr, "%s\n", explain_strndup(data, data_size)); exit(EXIT_FAILURE); } The above code example is available pre‐packaged as the explain_strndup_or_die(3) function. explain_errno_strndup const char *explain_errno_strndup(int errnum, const char *data, size_t data_size); The explain_errno_strndup function is used to obtain an explanation of an error returned by the strndup(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. data The original data, exactly as passed to the strndup(3) system call. data_size The original data_size, exactly as passed to the strndup(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: char *result = strndup(data, data_size); if (!result) { int err = errno; fprintf(stderr, "%s\n", explain_errno_strndup(err, data, data_size)); exit(EXIT_FAILURE); } The above code example is available pre‐packaged as the explain_strndup_or_die(3) function. explain_message_strndup void explain_message_strndup(char *message, int message_size, const char *data, size_t data_size); The explain_message_strndup function is used to obtain an explanation of an error returned by the strndup(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. data The original data, exactly as passed to the strndup(3) system call. data_size The original data_size, exactly as passed to the strndup(3) system call. Example: This function is intended to be used in a fashion similar to the following example: char *result = strndup(data, data_size); if (!result) { char message[3000]; explain_message_strndup(message, sizeof(message), data, data_size); fprintf(stderr, "%s\n", message); exit(EXIT_FAILURE); } The above code example is available pre‐packaged as the explain_strndup_or_die(3) function. explain_message_errno_strndup void explain_message_errno_strndup(char *message, int message_size, int errnum, const char *data, size_t data_size); The explain_message_errno_strndup function is used to obtain an explanation of an error returned by the strndup(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. data The original data, exactly as passed to the strndup(3) system call. data_size The original data_size, exactly as passed to the strndup(3) system call. Example: This function is intended to be used in a fashion similar to the following example: char *result = strndup(data, data_size); if (!result) { int err = errno; char message[3000]; explain_message_errno_strndup(message, sizeof(message), err, data, data_size); fprintf(stderr, "%s\n", message); exit(EXIT_FAILURE); } The above code example is available pre‐packaged as the explain_strndup_or_die(3) function.
SEE ALSO
strndup(3) duplicate a string explain_strndup_or_die(3) duplicate a string and report errors
COPYRIGHT
libexplain version 1.4
Copyright (C) 2009 Peter Miller
explain_strndup(3)