Chapter 5 C Routines Reference

JagGetCollectionList

Retrieve a list of all the collections defined in the server.

JagStatus JagGetCollectionList (
            JagNameList ** pList)

pList

A pointer to the address of the JagNameList structure.

Return value	To indicate
JAG_SUCCEED	Success
JAG_FAIL	Failure

Check the server's log file for more information when JagGetCollectionList fails.

The JagNameList structure is:

typedef struct _jagnamelist
{
    SQLINT            num_names;
    SQLPOINTER            *names;
} JagNameList;

where:

num_names is the number of array elements.

*names is an array of num_names elements; each element points to a null-terminated collection name.

You must use the JagFreeCollectionList method to free the memory allocated for the JagNameList structure.

See "Share Data Between C Components" in the EAServer Programmer's Guide for more information.