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

FreeBSD Manual Pages

  
 
  

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

NAME
       explain_fputs - explain fputs(3)	errors

SYNOPSIS
       #include	<libexplain/fputs.h>
       const char *explain_fputs(const char *s,	FILE *fp);
       const char *explain_errno_fputs(int errnum, const char *s, FILE *fp);
       void explain_message_fputs(char *message, int message_size, const char
       *s, FILE	*fp);
       void explain_message_errno_fputs(char *message, int message_size, int
       errnum, const char *s, FILE *fp);

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

   explain_fputs
       const char *explain_fputs(const char *s,	FILE *fp);

       The explain_fputs function is used to obtain an explanation of an error
       returned	 by  the fputs(3) system call. The least the message will con-
       tain is the value of strerror(errno), but usually it will do much  bet-
       ter, and	indicate the underlying	cause in more detail.

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

       s       The original s, exactly as passed to the	fputs(3) system	call.

       fp      The original fp,	exactly	as passed to the fputs(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:
	      if (fputs(s, fp) < 0)
	      {
		  fprintf(stderr, "%s\n", explain_fputs(s, fp));
		  exit(EXIT_FAILURE);
	      }

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

   explain_errno_fputs
       const char *explain_errno_fputs(int errnum, const char *s, FILE *fp);

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

       s       The original s, exactly as passed to the	fputs(3) system	call.

       fp      The original fp,	exactly	as passed to the fputs(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:
	      if (fputs(s, fp) < 0)
	      {
		  int err = errno;
		  fprintf(stderr, "%s\n", explain_errno_fputs(err, s, fp));
		  exit(EXIT_FAILURE);
	      }

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

   explain_message_fputs
       void explain_message_fputs(char *message, int message_size, const char
       *s, FILE	*fp);

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

       s       The original s, exactly as passed to the	fputs(3) system	call.

       fp      The original fp,	exactly	as passed to the fputs(3) system call.

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

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

   explain_message_errno_fputs
       void explain_message_errno_fputs(char *message, int message_size, int
       errnum, const char *s, FILE *fp);

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

       s       The original s, exactly as passed to the	fputs(3) system	call.

       fp      The original fp,	exactly	as passed to the fputs(3) system call.

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

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

SEE ALSO
       fputs(3)
	       write a string to a stream

       explain_fputs_or_die(3)
	       write a string to a stream and report errors

COPYRIGHT
       libexplain version 1.3
       Copyright (C) 2009 Peter	Miller

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

home | help