Search:

As defined in xcapi.h

Description:

Creates a container object of the specified type and registers a callback function for event notifications.

Container objects created with this call deliver discrete events only (with one update per callback invocation). To create a market data container object that delivers vectored events (i.e., multiple updates in a single callback, when appropriate), use xcCreateContainerWithVectoredEvents().

Restrictions:

• May not be called from within a callback function.
• Belongs to the Mutually Exclusive function set.

Parameters:

• session [IN] The handle to the parent SessionOrderEntry, SessionTicker or SessionTickerMonitoring object.
• object_type [IN] The XC Object Type ID, specifying the type of container object to create.
• object [OUT] The address of an xhandle variable to receive the handle to the newly created container object.
• callback [IN] Name of the client callback function to call with event notifications for the object. (May be set to NULL to ignore all events).
• turnkey [IN] Opaque, user-specified value which may be of use in identifying the object. (It can be requested from the object.)
• max_slots [IN] The number of slots for the new container. Slots are numbered from 0 to (max_slots - 1). Note that in general an application that uses fewer containers (each with multiple slots) will perform better than an application using many single-slot containers. The latter use case requires more memory and can also cause delays when xcDestroyObject() needs to be called for a very large number of objects.

Returns:

An xerr type indicating the status of the creation operation.

Common error codes:

XSUCCESS The container object was successfully created.
XINVAL Invalid parameter, object not created.
XTYPE An invalid object type parameter was supplied.
XTHREAD Called from an invalid thread.
XNOTCONNECTED Session not connected
XBADHANDLE Invalid handle.