wolfssl/doc/dox_comments/header_files/error-crypt.h

/*!
    \ingroup Error
    
    \brief This function stores the error string for a particular error code 
    in the given buffer.
    
    \return none No returns.
    
    \param error error code for which to get the string
    \param buffer buffer in which to store the error string. Buffer should be 
    at least WOLFSSL_MAX_ERROR_SZ (80 bytes) long
    
    _Example_
    \code
    char errorMsg[WOLFSSL_MAX_ERROR_SZ];
    int err = wc_some_function();

    if( err != 0) { // error occurred
    	wc_ErrorString(err, errorMsg);
    }
    \endcode
    
    \sa wc_GetErrorString
*/
WOLFSSL_API void wc_ErrorString(int err, char* buff);
/*!
    \ingroup Error
    
    \brief This function returns the error string for a particular error code.
    
    \return string Returns the error string for an error code as a 
    string literal.
    
    \param error error code for which to get the string
    
    _Example_
    \code
    char * errorMsg;
    int err = wc_some_function();

    if( err != 0) { // error occurred
    	errorMsg = wc_GetErrorString(err);
    }
    \endcode
    
    \sa wc_ErrorString
*/
WOLFSSL_API const char* wc_GetErrorString(int error);