|
Functions | |
| RDM_RETCODE | rdm_cursorClose (RDM_CURSOR cursor) |
| Close an RDM_CURSOR. More... | |
| RDM_RETCODE | rdm_cursorFree (RDM_CURSOR cursor) |
| Free an RDM_CURSOR. More... | |
Detailed Description
Cleanup API for core cursors. All the functions here are located in RDM DB Engine Library. Linker option:
-lrdmrdmSee RDM Cursor APIs for a more detailed description of a cursor.
Function Documentation
◆ rdm_cursorClose()
| RDM_RETCODE rdm_cursorClose | ( | RDM_CURSOR | cursor | ) |
#include <rdmcursorapi.h>
Close an RDM_CURSOR.
This function will close a cursor and free any status and row sets associated with the cursor. After a cursor has been closed it can continue to be used and associated with other row sets. Once a cursor has been freed with rdm_cursorFree() it can no longer be used.
- Locking Requirements
- None
- Return values
-
sOKAY Normal, successful return.
- See also
- rdm_dbAllocCursor
- rdm_dbGetRows
- rdm_cursorGetMemberRows
- rdm_cursorGetOwnerRow
- rdm_cursorGetRowsInReverseOrder
- rdm_cursorGetSelf
- rdm_cursorGetClone
- rdm_cursorFree
- Parameters
-
[in] cursor The cursor to be closed
◆ rdm_cursorFree()
| RDM_RETCODE rdm_cursorFree | ( | RDM_CURSOR | cursor | ) |
#include <rdmcursorapi.h>
Free an RDM_CURSOR.
This function will free all resources associated with a cursor. Attempting to use a cursor after it has been freed may result in an application crash.
- Locking Requirements
- None
- Return values
-
sOKAY Normal, successful return.
- See also
- rdm_cursorClose
- Parameters
-
[in] cursor The cursor to be freed
- Examples
- c-core/01_helloworld_c/core01Example_main.c, c-core/02_core/core02Example_main.c, c-core/03_core/core03Example_main.c, c-core/04_core/core04Example_main.c, c-core/05_core/core05Example_main.c, c-core/06_core/core06Example_main.c, c-core/07_core/core07Example_main.c, c-core/08_core/core08Example_main.c, c-core/09_core/core09Example_main.c, c-core/10_core/core10Example_main.c, c-core/11_core/core11Example_main.c, c-core/12_core/core12Example_main.c, c-core/13_core/core13Example_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/20_core/core20Example_main.c, c-core/21_core/core21Example_main.c, c-core/22_core/core22Example_main.c, c-core/23_core/core23Example_main.c, c-core/28_core/core28Example_main.c, c-core/29_core/core29Example_main.c, c-core/30_core/core30Example_main.c, c-core/31_core/core31Example_main.c, c-core/32_core/core32Example_main.c, c-core/33_core/core33Example_main.c, cursor/adoptChild.c, cursor/initialize_get_find_TheKing.c, cursor/insertAdults.c, cursor/insertChildren.c, cursor/insertChildrenWithSiblings.c, cursor/printAdults.c, cursor/printAdultsInReverseSortedOrder.c, cursor/printANumberOfAdultsArroundRecord.c, cursor/printANumberOfAdultsArroundRecordInSortedOrder.c, cursor/printChildNamesForMother.c, cursor/printMembers.c, cursor/printOurCommonChildrenNames.c, cursor/printParentNames.c, cursor/printSiblingNamesOnMothersSide.c, cursor/registerMembers.c, cursor/registerVoters.c, rtree/deleteZipcode.c, rtree/retrieveAllZipcode.c, rtree/retrieveContainedZipcode.c, rtree/retrieveExactZipcode.c, rtree/retrieveOverlapZipcode.c, and rtree/updateZipcode.c.
Referenced by RDM::TIME_SERIES::restore_aggregate< TIME_STAMP_KEY_T, SOURCE_TIME_STAMP_KEY, AGGREGATE_TIME_STAMP_KEY, AGGREGATE_T, NEXT >::put_range(), RDM::TIME_SERIES::restore_aggregate< TIME_STAMP_KEY_T, SOURCE_TIME_STAMP_KEY, AGGREGATE_TIME_STAMP_KEY, AGGREGATE_T, NEXT >::put_stat(), and RDM::TIME_SERIES::restore_aggregate< TIME_STAMP_KEY_T, SOURCE_TIME_STAMP_KEY, AGGREGATE_TIME_STAMP_KEY, AGGREGATE_T, NEXT >::put_value().
