db_cursor_t db_open_table_cursor ( db_t  hdb,
const db_objname_t table,
const db_table_cursor_t params 
)

Obtain a cursor to access the data in a table.

Parameters:
hdb Database handle.
table Table name. A name must start with a letter and can be followed by one or more letters, numbers, or underscores.
params Cursor parameter sturcture.
Returns:
  • Cursor handle.
  • NULL on failure.
Note:
When no longer needed, the cursor must be closed with db_close_cursor.
On failure, one of the following error codes is set:
  • DB_EINVAL Caused by: invalid database handle, table parameter is null, invalid params.flags value.
  • DB_ENAME Invalid name.
  • DB_EINDEX Unable to find cursor index using name sepcified.

See also:
db_close_cursor,
get_db_error, clear_db_error, Error Handling


Copyright © 2005-2008 ITTIA®. All rights reserved.