db_result_t db_describe_index ( db_t  hdb,
const db_objname_t table,
const db_objname_t index,
db_indexdef_t params 
)

Retrieves the schema definition for an index on a table.

Parameters:
hdb Database handle.
table Table name.
index Index name.
params Returned index configuration.
Returns:
On failure, one of the following error codes is set:
  • DB_EINVAL Caused by: invalid database handle, table name is null, index name is null or index configuration is null.
  • DB_ENOTFOUND Not found. Unable to find index with specified name.

See also:
db_create_index, db_drop_index,
get_db_error, clear_db_error, Error Handling


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