errors.h File Reference

Public API for XMSS error handling. More...

#include <types.h>

Include dependency graph for errors.h:

Go to the source code of this file.

Macros
#define	XMSS_ERRORS_H_INCLUDED
	Include guard.

Functions
const char *	xmss_error_to_name (XmssError error)
const char *	xmss_error_to_description (XmssError error)

Detailed Description

Public API for XMSS error handling.

Function Documentation

xmss_error_to_description()

const char* xmss_error_to_description

(

XmssError

error

)

Translate an XMSS error to a human-readable message.

Parameters

[in]

error

The error to translate.

Returns

A pointer to a static string with a message corresponding to error.

xmss_error_to_name()

const char* xmss_error_to_name

(

XmssError

error

)

Translate an XMSS error to the string with the enumeration-constant name.

As an example, xmss_error_to_name(XMSS_OKAY) returns "XMSS_OKAY".

Remarks

This function returns "XmssError_Undefined" for values of error that are not defined in XmssError.

Parameters

[in]

error

The error to translate.

Returns

A pointer to a static string with the enumeration-constant name corresponding to error.