Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
explain_fpathconf(3)	   Library Functions Manual	  explain_fpathconf(3)

NAME
       explain_fpathconf - explain fpathconf(3)	errors

SYNOPSIS
       #include	<libexplain/fpathconf.h>
       const char *explain_fpathconf(int fildes, int name);
       const char *explain_errno_fpathconf(int errnum, int fildes, int name);
       void  explain_message_fpathconf(char  *message,	int  message_size, int
       fildes, int name);
       void explain_message_errno_fpathconf(char *message,  int	 message_size,
       int errnum, int fildes, int name);

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

   explain_fpathconf
       const char *explain_fpathconf(int fildes, int name);

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

       This function is	intended to be used in a fashion similar to  the  fol-
       lowing example:
	      if (fpathconf(fildes, name) < 0)
	      {
		  fprintf(stderr, "%s\n", explain_fpathconf(fildes, name));
		  exit(EXIT_FAILURE);
	      }

       The  above code example is available pre-packaged as the	explain_fpath-
       conf_or_die(3) function.

       fildes  The original fildes, exactly as passed to the fpathconf(3) sys-
	       tem call.

       name    The original name, exactly as passed to the fpathconf(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, in-
	       cluding other threads.

       Note: This function is not thread safe, because it shares a return buf-
       fer across all threads, and many	other functions	in this	library.

   explain_errno_fpathconf
       const char *explain_errno_fpathconf(int errnum, int fildes, int name);

       The  explain_errno_fpathconf  function is used to obtain	an explanation
       of an error returned by the fpathconf(3)	system call.   The  least  the
       message	will  contain is the value of strerror(errnum),	but usually it
       will do much better, and	indicate the underlying	cause in more detail.

       This function is	intended to be used in a fashion similar to  the  fol-
       lowing example:
	      if (fpathconf(fildes, name) < 0)
	      {
		  int err = errno;
		  fprintf(stderr, "%s\n", explain_errno_fpathconf(err, fildes, name));
		  exit(EXIT_FAILURE);
	      }

       The  above code example is available pre-packaged as the	explain_fpath-
       conf_or_die(3) function.

       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.

       fildes  The original fildes, exactly as passed to the fpathconf(3) sys-
	       tem call.

       name    The original name, exactly as passed to the fpathconf(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, in-
	       cluding other threads.

       Note: This function is not thread safe, because it shares a return buf-
       fer across all threads, and many	other functions	in this	library.

   explain_message_fpathconf
       void  explain_message_fpathconf(char  *message,	int  message_size, int
       fildes, int name);

       The explain_message_fpathconf function may be used to  obtain an	expla-
       nation of an error returned by the fpathconf(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 de-
       tail.

       The errno global	variable will be used to obtain	the error value	to  be
       decoded.

       This  function  is intended to be used in a fashion similar to the fol-
       lowing example:
	      if (fpathconf(fildes, name) < 0)
	      {
		  char message[3000];
		  explain_message_fpathconf(message, sizeof(message), fildes, name);
		  fprintf(stderr, "%s\n", message);
		  exit(EXIT_FAILURE);
	      }

       The above code example is available pre-packaged	as the	explain_fpath-
       conf_or_die(3) function.

       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 re-
	       turned message.

       fildes  The original fildes, exactly as passed to the fpathconf(3) sys-
	       tem call.

       name    The original name, exactly as passed to the fpathconf(3)	system
	       call.

   explain_message_errno_fpathconf
       void explain_message_errno_fpathconf(char *message,  int	 message_size,
       int errnum, int fildes, int name);

       The  explain_message_errno_fpathconf  function may be used to obtain an
       explanation of an error returned	by the fpathconf(3) system call.   The
       least  the  message  will contain is the	value of strerror(errnum), but
       usually it will do much better, and indicate the	 underlying  cause  in
       more detail.

       This  function  is intended to be used in a fashion similar to the fol-
       lowing example:
	      if (fpathconf(fildes, name) < 0)
	      {
		  int err = errno;
		  char message[3000];
		  explain_message_errno_fpathconf(message, sizeof(message),
		      err, fildes, name);
		  fprintf(stderr, "%s\n", message);
		  exit(EXIT_FAILURE);
	      }

       The above code example is available pre-packaged	as the	explain_fpath-
       conf_or_die(3) function.

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

       fildes  The original fildes, exactly as passed to the fpathconf(3) sys-
	       tem call.

       name    The original name, exactly as passed to the fpathconf(3)	system
	       call.

SEE ALSO
       fpathconf(3)
	       get configuration values	for files

       explain_fpathconf_or_die(3)
	       get configuration values	for files and report errors

COPYRIGHT
       libexplain version 1.3
       Copyright (C) 2008 Peter	Miller

							  explain_fpathconf(3)

NAME | SYNOPSIS | DESCRIPTION | SEE ALSO | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=explain_fpathconf&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help