db_result_t db_describe_table ( db_t  hdb,
const db_objname_t name,
db_tabledef_t param,
db_flags_t  flags 
)

Obtain the schema definition for a table in a database.

Parameters:
hdb Database handle.
name Table name. A name must start with a letter and can be followed by one or more letters, numbers, or underscores.
param Table configuration.
flags 
Returns:
On failure, one of the following error codes is set:
  • DB_EINVAL Caused by: invalid database handle, table name is null, table configuration is null, invalid flags, index defintion is null, index field is null.
  • DB_ENAME Table name is not in a valid format.

See also:
db_create_table,
get_db_error, clear_db_error, Error Handling


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