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

FreeBSD Manual Pages

  
 
  

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

NAME
       explain_tcsendbreak - explain tcsendbreak(3) errors

SYNOPSIS
       #include	<libexplain/tcsendbreak.h>
       const char *explain_tcsendbreak(int fildes, int duration);
       const char *explain_errno_tcsendbreak(int errnum, int fildes, int dura-
       tion);
       void explain_message_tcsendbreak(char *message, int message_size, int
       fildes, int duration);
       void explain_message_errno_tcsendbreak(char *message, int message_size,
       int errnum, int fildes, int duration);

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

   explain_tcsendbreak
       const char *explain_tcsendbreak(int fildes, int duration);

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

       fildes  The  original  fildes,  exactly as passed to the	tcsendbreak(3)
	       system call.

       duration
	       The original duration, exactly as passed	to the	tcsendbreak(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 (tcsendbreak(fildes, duration)	< 0)
	      {
		  fprintf(stderr, "%s\n", explain_tcsendbreak(fildes, dura-
		  tion));
		  exit(EXIT_FAILURE);
	      }

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

   explain_errno_tcsendbreak
       const char *explain_errno_tcsendbreak(int errnum, int fildes, int dura-
       tion);

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

       fildes  The  original  fildes,  exactly as passed to the	tcsendbreak(3)
	       system call.

       duration
	       The original duration, exactly as passed	to the	tcsendbreak(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 (tcsendbreak(fildes, duration)	< 0)
	      {
		  int err = errno;
		  fprintf(stderr, "%s\n", explain_errno_tcsendbreak(err,
		  fildes, duration));
		  exit(EXIT_FAILURE);
	      }

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

   explain_message_tcsendbreak
       void explain_message_tcsendbreak(char *message, int message_size, int
       fildes, int duration);

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

       fildes  The original fildes, exactly as passed  to  the	tcsendbreak(3)
	       system call.

       duration
	       The  original duration, exactly as passed to the	tcsendbreak(3)
	       system call.

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

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

   explain_message_errno_tcsendbreak
       void explain_message_errno_tcsendbreak(char *message, int message_size,
       int errnum, int fildes, int duration);

       The explain_message_errno_tcsendbreak function is used to obtain	an ex-
       planation  of an	error returned by the tcsendbreak(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.

       fildes  The  original  fildes,  exactly as passed to the	tcsendbreak(3)
	       system call.

       duration
	       The original duration, exactly as passed	to the	tcsendbreak(3)
	       system call.

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

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

SEE ALSO
       tcsendbreak(3)
	       send terminal line break

       explain_tcsendbreak_or_die(3)
	       send terminal line break	and report errors

COPYRIGHT
       libexplain version 1.3
       Copyright (C) 2009 Peter	Miller

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

home | help