Collaboration diagram for Cursor Cleanup Functions:

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 fuctions here are
located in \ref lib_rdm. Linker option:\
 <pre><code>    -l<tt><a href="lib_rdm.html">rdmrdm</a></tt></code></pre>  See \ref cursor 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 [in] 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 [in] The cursor to be freed