Chapter 5 C Routines Reference


JagGetSharedDataByIndex

Description

Use the shared variable index number to retrieve a shared variable handle.

Syntax

JagStatus JagGetSharedData (
JagDataCollection * pCollection,
SQLINTEGER index,
JagSharedData ** ppData)

Parameters

pCollection 

The handle of the collection to which the shared variable belongs.

index

The index of the shared variable.

ppProp 

The shared variable handle. *ppProp is set to NULL if the shared variable does not exist.

Return Values

Return value

To indicate

JAG_SUCCEED

Success, even if the property does not exist

JAG_FAIL

Failure

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

Usage

This routine can retrieve only the handle of a property that has been created using the JagNewSharedDataByIndex routine.

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

See Also

JagFreeSharedDataHandle, JagGetSharedData, JagGetSharedDataByIndex, JagNewSharedData

 


Copyright © 2000 Sybase, Inc. All rights reserved.