Search:

As defined in xcapi.h

Description:

Submits a data item to the Exegy appliance system for persistent storage or temporary use. Prior to calling xcSubmitItemByString(), one of the "set field" functions--xcSetField(), xcSetFieldArray(), xcSetFieldGroup(), xcSetFieldGroupArray--is used to set fields in the object with appropriate values for the data item. Valid only for the RW-BasketDefinition, RW-KeylistDefinition, RW-KeylistFilterDefinition, ST-BasketConstituent,and WRITEONLY ("WO") objects. Note that if the function returns XSUCCESS, the caller can expect a callback on the given slot. If the function returns an error, no operation took place.

Restrictions:

• May not be called from within a callback function.
• Belongs to the Mutually Exclusive function set.
• Valid only for "RW" (READWRITE) and "WO" (WRITEONLY) objects, and for ST-BasketConstituent.

Parameters:

• container [IN] The handle to the object.
• key_string [IN] The Exegy key string identifying the data item being submitted. An Exegy key string for a financial instrument takes the form: countrycode:exchangeid:symbol , where countrycode is the 2-character Exegy country identifier, exchangeid the 1- or 2 character Exegy exchange ID, and symbol a string identifying a unique financial instrument on the exchange. Baskets, keylists, and keylist filters have key string identifiers of the same form, in which the countrycode and exchangeid portions of the identifier are fixed (XX:BX for baskets, XX:UX for keylists, XX:RX for keylist filters) and the symbol portion is a user-supplied name for the item.
• turnkey [IN] Opaque value that will be stored in the targeted container object and passed to callback function when the latter is triggered for this data item.
• slot [IN] Slot number for the slot holding the data item being submitted.

Returns:

An xerr type indicating the status of the operation.

Common error codes:

XSUCCESS The operation completed successfully.
XINVAL An invalid parameter was supplied.
XBADSLOT The specified slot range is not valid.
XTYPE The specified container is not of a compatible type.
XNOTCONNECTED Session not connected.
XBADHANDLE Invalid handle.
XREADONLY Invalid call for read-only field or container.