RDM Return Code APIs

Collaboration diagram for RDM Return Code APIs:

Functions
RDM_RETCODE	rdm_retcodeGetCode (const char *retCodeName)
	Get the numeric RDM status code for a literal status name. More...
const char *	rdm_retcodeGetDescription (RDM_RETCODE retcode)
	Invoke RDM error handler. More...
const char *	rdm_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 char *

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 char* 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]

retcode

Status or error code returned by an RDM API function

Examples

c-core/01_helloworld_c/core01Example_main.c, c-core/14_core/core14Example_main.c, c-core/15_core/core15Example_main.c, c-core/16_core/core16Example_main.c, c-core/17_core/core17Example_main.c, c-core/18_core/core18Example_main.c, c-core/19_core/core19Example_main.c, c-core/31_core/core31Example_main.c, c-core/32_core/core32Example_main.c, c-core/33_core/core33Example_main.c, and c-core/34_core/core34Example_main.c.

rdm_retcodeGetName()

const char* 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]

retcode

Status or error code returned by an RDM API function

Examples

c-core/01_helloworld_c/core01Example_main.c, c-core/14_core/core14Example_main.c, c-core/15_core/core15Example_main.c, c-core/16_core/core16Example_main.c, c-core/17_core/core17Example_main.c, c-core/18_core/core18Example_main.c, c-core/19_core/core19Example_main.c, c-core/31_core/core31Example_main.c, c-core/32_core/core32Example_main.c, c-core/33_core/core33Example_main.c, and c-core/34_core/core34Example_main.c.