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 #if !defined(RDMRETCODEAPI_H_INCLUDED_)
18 #define RDMRETCODEAPI_H_INCLUDED_
19 
20 #if defined(__cplusplus) && !defined(CPP_HEADER_INCLUDED)
21 #error rdmretcodeapi.h is only for C applications. Do not include it directly in C++ applications. Use cpp-rdmretcodeapi.h instead
22 #endif
23 
24 #include "psptypes.h"
25 #include "rdmretcodetypes.h"
26 
37 #if !defined(RDM_NO_UNICODE)
38 #define rdm_retcodeGetCode RDM_T_FUNC(rdm_retcodeGetCode)
39 #define rdm_retcodeGetDescription RDM_T_FUNC(rdm_retcodeGetDescription)
40 #define rdm_retcodeGetName RDM_T_FUNC(rdm_retcodeGetName)
41 #endif
42 
57 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_retcodeGetCode (
58  const RDM_TCHAR_T *retCodeName
59  );
60 
68 RDM_EXPORT const RDM_TCHAR_T* EXTERNAL_FCN rdm_retcodeGetDescription (
69  RDM_RETCODE retcode
70  );
71 
72 
87 RDM_EXPORT const RDM_TCHAR_T* EXTERNAL_FCN rdm_retcodeGetName (
88  RDM_RETCODE retcode
89  );
90 
93 #endif /* RDMRETCODEAPI_H_INCLUDED_ */
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:134
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.