Collaboration diagram for Miscellaneous functions:

Functions

RDM_RETCODE rdm_cursorGetLockStatus (RDM_CURSOR cursor, RDM_LOCK_STATUS *status)
Get the lock status of a table. More...

Detailed Description

API for other miscellaneous core cursor functions.  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_cursorGetLockStatus()

RDM_RETCODE rdm_cursorGetLockStatus ( RDM_CURSOR cursor,
RDM_LOCK_STATUS * status
)

#include <rdmcursorapi.h>

Get the lock status of a table.

This function returns the current lock status of the table the cursor is based on. If the database handle that cursor is based on does not have a lock on the table then the status will be RDM_LOCK_FREE regardless of whether any other users have the table locked.

Locking Requirements
None
Return values
sOKAY Normal, successful return.
eDBNOTOPEN Database not open.
See also
rdm_dbOpen
rdm_dbGetLockStatus
rdm_cursorGetLockStatus
rdm_dbGetTransactionStatus
rdm_dbStartUpdate
rdm_dbStartRead
rdm_dbStartSnapshot
rdm_dbGetRows
rdm_dbEnd
rdm_transEnd
Parameters
[in] cursor [in] A valid RDM_CURSOR handle
[out] status [out] The current lock status for the table associated with the cursor