The LMX_GetErrorMessageSimple function retrieves a string for a corresponding status value.

Prototype

const char * LMX_GetErrorMessageSimple
(
   LMX_STATUS LmxStat
);

Parameters

LmxStat
[in] Error status variable.

Return values

The return value is a pointer to a NULL-terminated string that contains descriptive text for the error code.

Example

You can use the following code to print out the name of the corresponding LM-X return code in the format described in Return codes.

#include <lmx.h>
#include <stdio.h>

int main() 
{
  LMX_STATUS s = LMX_INVALID_PARAMETER;
  fprintf(stderr, "%s\n", LMX_GetErrorMessageSimple(s));
  return 0;
}