Products Support Documentation Download
RDM Return Code APIs
Collaboration diagram for RDM Return Code APIs:

Functions

RDM_RETCODE rdm_retcodeGetCode (const RDM_TCHAR_T *retCodeName)
 Get the numeric RDM status code for a literal status name. More...
 
const RDM_TCHAR_Trdm_retcodeGetDescription (RDM_RETCODE retcode)
 Invoke RDM error handler. More...
 
const RDM_TCHAR_Trdm_retcodeGetName (RDM_RETCODE retcode)
 Get the mnemonic name for an error or status code. More...
 

Detailed Description

The RDM return code API. The functions here are located in RDM DB Engine Library. Linker option:

    -lrdmrdm

Function Documentation

◆ rdm_retcodeGetCode()

RDM_RETCODE rdm_retcodeGetCode ( const RDM_TCHAR_T retCodeName)

#include <rdmretcodeapi.h>

Get the numeric RDM status code for a literal status name.

This function returns the RDM status code associated with the specified mnemonic status name.

Locking Requirements
None
Returns
  • An RDM_RETCODE value that corresponds to the mnemonic status name
  • eSYS_BADERRCODE if an invalid mnemonic status name is given
See also
rdm_retcodeGetName

◆ rdm_retcodeGetDescription()

const RDM_TCHAR_T* rdm_retcodeGetDescription ( RDM_RETCODE  retcode)

#include <rdmretcodeapi.h>

Invoke RDM error handler.

Returns
  • The status/error code description string
  • NULL if an invalid RDM_RETCODE value is given
See also
rdm_retcodeGetName
Parameters
[in]retcodeStatus or error code returned by an RDM API function
Examples:
tutorials/HelloWorld/hello_worldTutorial_main.c.

◆ rdm_retcodeGetName()

const RDM_TCHAR_T* rdm_retcodeGetName ( RDM_RETCODE  retcode)

#include <rdmretcodeapi.h>

Get the mnemonic name for an error or status code.

This function returns the mnemonic name associated with the specified error or status code.

Locking Requirements
None
Returns
  • The status/error code mnemonic name string
  • NULL if an invalid RDM_RETCODE value is given
See also
rdm_retcodeGetDescription
Parameters
[in]retcodeStatus or error code returned by an RDM API function
Examples:
tutorials/HelloWorld/hello_worldTutorial_main.c.