*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->Tru64 Unix man pages -> ERR_error_string (3)              
Title
Content
Arch
Section
 

ERR_error_string(3)

Contents


NAME    [Toc]    [Back]

       ERR_error_string,                      ERR_error_string_n,
       ERR_lib_error_string,   ERR_func_error_string,    ERR_reason_error_string
 - Obtain human-readable error message

SYNOPSIS    [Toc]    [Back]

       #include <openssl/err.h>

       char *ERR_error_string(
               unsigned    long    e,    char    *buf   );   char
       *ERR_error_string_n(
               unsigned long e, char *buf, size_t  len  );  const
       char *ERR_lib_error_string(
               unsigned      long     e     );     const     char
       *ERR_func_error_string(
               unsigned  long   e   );   const   char   *ERR_reason_error_string(

               unsigned long e );

DESCRIPTION    [Toc]    [Back]

       The ERR_error_string() function generates a human-readable
       string representing the error code e,  and  places  it  at
       buf.  The  buf  must be at least 120 bytes long. If buf is
       NULL, the error string is placed in a static  buffer.  The
       ERR_error_string_n()   function   is   a  variant  of  the
       ERR_error_string() functon that writes at most len characters
  (including  the  terminating  0)  and  truncates the
       string if necessary. For ERR_error_string_n(), buf  cannot
       be NULL.

       The string will have the following format:
        error:[error code]:[library name]:[function name]:[reason
       string]

       The error code  is  an  8-digit  hexadecimal  number.  The
       library  name,  function name, and reason string are ASCII
       text.

       The ERR_lib_error_string(),  ERR_func_error_string(),  and
       ERR_reason_error_string()  functions  return  the  library
       name, function name and reason string respectively.

       The OpenSSL error strings should be loaded by first  calling
  ERR_load_crypto_strings()  or,  for SSL applications,
       SSL_load_error_strings(). If there is no text string  registered
  for  the  given error code, the error string will
       contain the numeric code.

       The ERR_print_errors() function can be used to  print  all
       error codes currently in the queue.

RETURN VALUES    [Toc]    [Back]

       The  ERR_error_string()  function  returns  a pointer to a
       static buffer containing the string if buf  ==  NULL,  buf
       otherwise.

       The  ERR_lib_error_string(),  ERR_func_error_string(), and
       ERR_reason_error_string() functions  return  the  strings,
       and NULL if none is registered for the error code.



HISTORY    [Toc]    [Back]

       The  ERR_error_string()  function is available in all versions
 of  SSLeay  and  OpenSSL.  The  ERR_error_string_n()
       function was added in OpenSSL 0.9.6.

SEE ALSO    [Toc]    [Back]

      
      
       Functions:            err(3),            ERR_get_error(3),
       ERR_load_crypto_strings(3),      SSL_load_error_strings(3)
       ERR_print_errors(3)



                                              ERR_error_string(3)
[ Back ]
 Similar pages
Name OS Title
scan_scaled OpenBSD handle numbers with a human-readable scale
fmt_scaled OpenBSD handle numbers with a human-readable scale
format_bytes NetBSD format a number into a human readable form
humanize_number NetBSD format a number into a human readable form
accessdb Linux dumps the content of a man-db database in a human readable format.
sdp FreeBSD convert numeric SDP attribute/UUID value into human readable description
SDP_GET128 FreeBSD convert numeric SDP attribute/UUID value into human readable description
sdp_uuid2desc FreeBSD convert numeric SDP attribute/UUID value into human readable description
sdp_attr2desc FreeBSD convert numeric SDP attribute/UUID value into human readable description
sdp_search FreeBSD convert numeric SDP attribute/UUID value into human readable description
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service