Purpose

Return a text description of an error status.

Syntax

#include "spd.h"
 
char *SPD_GetErrorMessage(
   SPD_errorTP error
);

Description

error

identifies the type of error. See 8.1 for the list of possible errors.

Return Value

This function returns a pointer to the error message text if the input argument is a valid error type.

It returns a pointer to a default error message if the error type is invalid.

The pointer that is returned points to a static buffer.