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.

Return Values

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 Jaguar 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 "Share Data Between C Components" in the Jaguar CTS Programmer's Guide for more information.

See Also

JagFreeCollectionHandle, JagGetCollection, JagLockCollection, JagLockNoWaitCollection, JagNewCollection, JagUnlockCollection

Copyright © 2000 Sybase, Inc. All rights reserved.