JagGetCollection  JagGetHostName

Chapter 5: C Routines Reference

JagGetCollectionList

Description

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

Syntax

JagStatus JagGetCollectionList (
            JagNameList ** pList)

Parameters

pList

A pointer to the address of the JagNameList structure.

Returns

Return value

To indicate

JAG_SUCCEED

Success

JAG_FAIL

Failure

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

Usage

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 Appendix C, “Creating C Components,” in the EAServer Programmer’s Guide for more information.

See also

JagFreeCollectionList





Copyright © 2005. Sybase Inc. All rights reserved. JagGetHostName