MemCom Reference Manual > MemCom C API Manual Pages > Relational Table Manager Functions > mcTBloadDesc

Name

mcTBloadDesc — Load dataset descriptor table

Synopsis

#include <memcom.h>

mcRTable* mcTBloadDesc(int handle, const char* name);

Description

mcTBloadDesc loads a descriptor of a dataset from a database in memory, creating a structure of type mcRTable. If completed successfully, the function creates a relational table, loads the descriptor from the database, and returns a pointer to the table in memory. Otherwise, 0 is returned and the error code can be retrieved by the function mcErrStatus. If the descriptor of the set name is not defined, 0 is returned and a warning is flagged in mcErrStatus. To free the descriptor table from memory make use of mcTBfree.

Parameters

handle

Database handle (input).

name

Name of dataset from which the descriptor is loaded in memory (input).

Additional Notes

The existence of a dataset descriptor can be verified by means of mcDBinqSetAtt. If the descriptor exists, the dsize field of the mcSetAttributes structure is non-zero.

See also

mcTBfree, mcTBstoreDesc.