Products Support Documentation Download
rdmrdmapi.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(RDMRDMAPI_H_INCLUDED)
18 #define RDMRDMAPI_H_INCLUDED
19 
20 #if defined(__cplusplus) && !defined(CPP_HEADER_INCLUDED)
21 #error rdmrdmapi.h is only for C applications. Do not include it directly in C++ applications. Use cpp-rdmrdmapi.h instead
22 #endif
23 
24 #include "rdmtypes.h"
25 #include "rdmtfstypes.h"
26 
65 #if !defined(RDM_NO_UNICODE)
66 #define rdm_rdmAllocTFS RDM_T_FUNC(rdm_rdmAllocTFS)
67 #define rdm_rdmAllocTFSWithMemBuf RDM_T_FUNC(rdm_rdmAllocTFSWithMemBuf)
68 #define rdm_rdmGetVersion RDM_T_FUNC(rdm_rdmGetVersion)
69 #endif
70 
90 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_rdmAllocDatabase (
91  RDM_DB *pDb
92  );
93 
143 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_rdmAllocTFS (
144  const RDM_TCHAR_T *optString,
145  RDM_TFS *phTFS
146  );
147 
189 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_rdmAllocTFSWithMemBuf (
190  const RDM_TCHAR_T *optString,
191  void *pMemBuf,
192  size_t memSize,
193  RDM_TFS *phTFS)
194 ;
195 
216 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_rdmGetAfterLast (
217  RDM_CURSOR *pCursor
218  );
219 
220 
239 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_rdmGetBeforeFirst (
240  RDM_CURSOR *pCursor
241  );
242 
243 
273 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_rdmGetVersion (
274  const RDM_TCHAR_T *fmt,
275  RDM_TCHAR_T *buf,
276  size_t bytesIn
277  );
278 
279 #endif /* RDMRDMAPI_H_INCLUDED */
struct RDM_CURSOR_S * RDM_CURSOR
Definition: rdmtypes.h:241
Header for the native RDM Runtime types.
RDM_RETCODE rdm_rdmGetAfterLast(RDM_CURSOR *pCursor)
Get the special AfterLast cursor.
struct RDM_TFS_S * RDM_TFS
RDM TFS Handle.
Definition: rdmtfstypes.h:21
RDM_RETCODE rdm_rdmAllocDatabase(RDM_DB *pDb)
Allocate memory for a new RDM db.
RDM_RETCODE
RDM status and error return codes.
RDM_RETCODE rdm_rdmAllocTFS(const RDM_TCHAR_T *optString, RDM_TFS *phTFS)
Allocate the TFS handle.
RDM_RETCODE rdm_rdmAllocTFSWithMemBuf(const RDM_TCHAR_T *optString, void *pMemBuf, size_t memSize, RDM_TFS *phTFS)
Allocate the TFS with an associated memory buffer.
RDM_RETCODE rdm_rdmGetBeforeFirst(RDM_CURSOR *pCursor)
Get the special BeforeFirst cursor.
struct RDM_DB_S * RDM_DB
Definition: rdmtypes.h:240
RDM_RETCODE rdm_rdmGetVersion(const RDM_TCHAR_T *fmt, RDM_TCHAR_T *buf, size_t bytesIn)
Return RDM Db Engine version information.
Header for the Transactional File Server (TFS) types.
#define RDM_TCHAR_T
Definition: psptypes.h:134