JagGetSharedData

Description

Use the shared variable name to retrieve a shared variable handle.

Syntax

JagStatus JagGetSharedData (
            JagDataCollection * pCollection,
            SQLPOINTER name,
            JagSharedData ** ppProp)

Parameters

pCollection

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

name

The name of the shared variable.

ppProp

The shared variable handle. JagGetSharedData sets *ppProp to NULL if the shared variable does not exist.

Returns

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 JagGetSharedData fails.

Usage

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

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

See also

JagFreeSharedDataHandle, JagGetSharedDataByIndex, JagNewSharedData, JagNewSharedDataByIndex