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

FreeBSD Manual Pages

  
 
  

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

NAME
       explain_strtoul_or_die -	convert	string to unsigned long	and report er-
       rors

SYNOPSIS
       #include	<libexplain/strtoul.h>
       unsigned	long explain_strtoul_or_die(const char *nptr,  char  **endptr,
       int base);
       unsigned	long explain_strtoul_on_error(const char *nptr,	char **endptr,
       int base))

DESCRIPTION
       The explain_strtoul_or_die function is used to call the strtoul(3) sys-
       tem call. On failure an explanation will	be printed to stderr, obtained
       from the	explain_strtoul(3) function, and then the  process  terminates
       by calling exit(EXIT_FAILURE).

       The  explain_strtoul_on_error  function	is used	to call	the strtoul(3)
       system call. On failure an explanation will be printed to  stderr,  ob-
       tained  from  the explain_strtoul(3) function, but still	returns	to the
       caller.

       nptr    The nptr, exactly as to be  passed  to  the  strtoul(3)	system
	       call.

       endptr  The  endptr,  exactly  as to be passed to the strtoul(3)	system
	       call.

       base    The base, exactly as to be  passed  to  the  strtoul(3)	system
	       call.

RETURN VALUE
       The  explain_strtoul_or_die  function only returns on success, see str-
       toul(3) for more	information. On	failure, prints	an explanation and ex-
       its, it does not	return.

       The  explain_strtoul_on_error  function always returns the value	return
       by the wrapped strtoul(3) system	call.

EXAMPLE
       The explain_strtoul_or_die function is intended to be used in a fashion
       similar to the following	example:
	      unsigned long result = explain_strtoul_or_die(nptr, endptr, base);

SEE ALSO
       strtoul(3)
	       convert a string	to an unsigned long integer

       explain_strtoul(3)
	       explain strtoul(3) errors

       exit(2) terminate the calling process

COPYRIGHT
       libexplain version 1.3
       Copyright (C) 2009 Peter	Miller

						     explain_strtoul_or_die(3)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | EXAMPLE | SEE ALSO | COPYRIGHT

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

home | help