Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The LMX_GetErrorMessage function retrieves a NULL-terminated string for the last LM-X function call that occurred.

...

Prototype

const char * LMX_GetErrorMessage
(
LMX_HANDLE LmxHandle
);

...

Parameters

LmxHandle

[in/out] LM-X handle.

Return Values

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

...

...

Remarks

This function returns a detailed message for the last LM-X function call that occurred.

The message includes the feature name, internal error code, and context-specific error whenever relevant. Typically, the context-specific error and internal error code are used only by X-Formation for support purposes.

Example:

LM-X Error: (Internal: 33 Feature: f1)
Feature not found
For further information go to http://www.x-formation.com

The pointer returned is guaranteed to be valid only until the next function call that uses the LmxHandle parameter. Accordingly, you are recommended not to store the pointer.

Note: You cannot call LMX_GetErrorMessage from the heartbeat callback functions (see Heartbeats and LMX_SetOption). Instead, you may call LMX_GetErrorMessageSimple(See "LMX_GetErrorMessageSimple" on page ).