Products Support Documentation Download
rdmretcodeapi.h
Go to the documentation of this file.
1 /* ----------------------------------------------------------------------------
2  * Raima Database Manager
3  *
4  * Copyright (c) 2014 Raima Inc., All rights reserved.
5  *
6  * Use of this software, whether in source code format, or in executable,
7  * binary object code form, is governed by the Raima LICENSE which
8  * is fully described in the LICENSE.TXT file, included within this
9  * distribution of files.
10  * ----------------------------------------------------------------------------
11  */
12 
17 #include "psptypes.h"
18 #include "rdmretcodetypes.h"
19 
30 #if defined(RDM_UNICODE)
31 #define rdm_retcodeGetCode RDM_T_FUNC (rdm_retcodeGetCode)
32 #define rdm_retcodeGetDescription RDM_T_FUNC (rdm_retcodeGetDescription)
33 #define rdm_retcodeGetName RDM_T_FUNC (rdm_retcodeGetName)
34 #endif
35 
36 #if defined(__cplusplus)
37 extern "C" {
38 #endif
39 
54 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN
55 rdm_retcodeGetCode (const RDM_TCHAR_T *retCodeName);
56 
64 RDM_EXPORT const RDM_TCHAR_T *EXTERNAL_FCN rdm_retcodeGetDescription (
65  RDM_RETCODE retcode
66 );
67 
82 RDM_EXPORT const RDM_TCHAR_T *EXTERNAL_FCN rdm_retcodeGetName (
83  RDM_RETCODE retcode
84 );
85 
86 #if defined(__cplusplus)
87 }
88 #endif
89 
const RDM_TCHAR_T * rdm_retcodeGetName(RDM_RETCODE retcode)
Get the mnemonic name for an error or status code.
Header for the Platform Support Package - Platform dependent types.
RDM Status and Error Return Codes.
RDM_RETCODE
RDM status and error return codes.
#define RDM_TCHAR_T
Definition: psptypes.h:130
RDM_RETCODE rdm_retcodeGetCode(const RDM_TCHAR_T *retCodeName)
Get the numeric RDM status code for a literal status name.
const RDM_TCHAR_T * rdm_retcodeGetDescription(RDM_RETCODE retcode)
Invoke RDM error handler.