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

FreeBSD Manual Pages

  
 
  

home | help
explain_iconv_open_or_die(3Library Functions Manuaexplain_iconv_open_or_die(3)

NAME
       explain_iconv_open_or_die  -  prepare for charset conversion and	report
       errors

SYNOPSIS
       #include	<libexplain/iconv_open.h>
       iconv_t explain_iconv_open_or_die(const char *tocode, const char	*from-
       code);
       iconv_t	explain_iconv_open_on_error(const  char	 *tocode,  const  char
       *fromcode);

DESCRIPTION
       The  explain_iconv_open_or_die	function   is	used   to   call   the
       iconv_open(3) system call. On failure an	explanation will be printed to
       stderr, obtained	from the explain_iconv_open(3) function, and then  the
       process terminates by calling exit(EXIT_FAILURE).

       The   explain_iconv_open_on_error   function   is   used	 to  call  the
       iconv_open(3) system call. On failure an	explanation will be printed to
       stderr, obtained	from the explain_iconv_open(3) function, but still re-
       turns to	the caller.

       tocode  The tocode, exactly as to be passed to the iconv_open(3)	system
	       call.

       fromcode
	       The fromcode, exactly as	to be passed to	the iconv_open(3) sys-
	       tem call.

RETURN VALUE
       The explain_iconv_open_or_die function only  returns  on	 success,  see
       iconv_open(3)  for  more	information. On	failure, prints	an explanation
       and exits, it does not return.

       The explain_iconv_open_on_error function	always returns the  value  re-
       turn by the wrapped iconv_open(3) system	call.

EXAMPLE
       The  explain_iconv_open_or_die  function	 is  intended  to be used in a
       fashion similar to the following	example:
	      iconv_t result = explain_iconv_open_or_die(tocode, fromcode);

SEE ALSO
       iconv_open(3)
	       allocate	descriptor for character set conversion

       explain_iconv_open(3)
	       explain iconv_open(3) errors

       exit(2) terminate the calling process

COPYRIGHT
       libexplain version 1.3
       Copyright (C) 2013 Peter	Miller

						  explain_iconv_open_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_iconv_open_or_die&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help