Chapter 5: C Routines Reference

JagGetCollection

Description

Retrieve a shared data collection handle.

Syntax

JagStatus JagGetCollection (
            SQLPOINTER name,
            JagDataCollection ** ppCollection)

Parameters

name: The name of the collection.

ppCollection: The address of a JagDataCollection handle. ppCollection is set to NULL if the specified collection does not exist.

Returns

Return value	To indicate
JAG_SUCCEED	Success
JAG_FAIL	Failure

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

Usage

JagGetCollection retrieves a shared data collection handle. The collection must have been previously created by JagNewCollection.

Collections can be shared only among components that are installed in the same EAServer package. A collection created by a component that is installed in one package can not be retrieved by a component that is installed in a different package.

See Appendix C, “Creating C Components,” in the EAServer Programmer’s Guide for more information.