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

FreeBSD Manual Pages

  
 
  

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

NAME
       explain_acl_get_file - explain acl_get_file(3) errors

SYNOPSIS
       #include	<libexplain/acl_get_file.h>
       const char *explain_acl_get_file(const char *pathname, acl_type_t
       type);
       const char *explain_errno_acl_get_file(int errnum, const	char *path-
       name, acl_type_t	type);
       void explain_message_acl_get_file(char *message,	int message_size,
       const char *pathname, acl_type_t	type);
       void explain_message_errno_acl_get_file(char *message, int mes-
       sage_size, int errnum, const char *pathname, acl_type_t type);

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

   explain_acl_get_file
       const char *explain_acl_get_file(const char *pathname, acl_type_t
       type);

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

       pathname
	       The original pathname, exactly as passed	to the acl_get_file(3)
	       system call.

       type    The original type, exactly as  passed  to  the  acl_get_file(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 buf-
       fer 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:
	      acl_t result = acl_get_file(pathname, type);
	      if (result < 0)
	      {
		  fprintf(stderr, "%s\n", explain_acl_get_file(pathname,
		  type));
		  exit(EXIT_FAILURE);
	      }

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

   explain_errno_acl_get_file
       const char *explain_errno_acl_get_file(int errnum, const	char *path-
       name, acl_type_t	type);

       The explain_errno_acl_get_file function is used to obtain  an  explana-
       tion of an error	returned by the	acl_get_file(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.

       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 acl_get_file(3)
	       system call.

       type    The  original  type,  exactly  as passed	to the acl_get_file(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 buf-
       fer 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:
	      acl_t result = acl_get_file(pathname, type);
	      if (result < 0)
	      {
		  int err = errno;
		  fprintf(stderr, "%s\n", explain_errno_acl_get_file(err,
		  pathname, type));
		  exit(EXIT_FAILURE);
	      }

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

   explain_message_acl_get_file
       void explain_message_acl_get_file(char *message,	int message_size,
       const char *pathname, acl_type_t	type);

       The explain_message_acl_get_file	function is used to obtain an explana-
       tion of an error	returned by the	acl_get_file(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.

       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 acl_get_file(3)
	       system call.

       type    The original type, exactly as  passed  to  the  acl_get_file(3)
	       system call.

       Example:	 This  function	is intended to be used in a fashion similar to
       the following example:
	      acl_t result = acl_get_file(pathname, type);
	      if (result < 0)
	      {
		  char message[3000];
		  explain_message_acl_get_file(message,	sizeof(message), path-
		  name,	type);
		  fprintf(stderr, "%s\n", message);
		  exit(EXIT_FAILURE);
	      }

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

   explain_message_errno_acl_get_file
       void explain_message_errno_acl_get_file(char *message, int mes-
       sage_size, int errnum, const char *pathname, acl_type_t type);

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

       type    The  original  type,  exactly  as passed	to the acl_get_file(3)
	       system call.

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

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

SEE ALSO
       acl_get_file(3)
	       Execute acl_get_file(3)

       explain_acl_get_file_or_die(3)
	       Execute acl_get_file(3) and report errors

COPYRIGHT
       libexplain version 1.3
       Copyright (C) 2013 Peter	Miller

						       explain_acl_get_file(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_acl_get_file&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help