Search:

As defined in xcapi.h

Description:

Removes the specified item from persistent storage on the Exegy appliance. If the function returns XSUCCESS, the caller can expect at least one callback (event notification) for the targeted slot. Upon successful completion of the delete operation, any data in the targeted slot is cleared, and the slot is returned to an empty state. If other objects (of any type) are subscribed to a data item at the time it is deleted from permanent storage, those objects also receive a callback as notification of the delete: in addition, the slots associated with the deleted data item are cleared, and the objects stop receiving data updates for the item/slot. (While the delete operation is pending, the usual callbacks/events associated with the data item continue to occur uninterrupted.)

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.

Parameters:

• container [IN] Handle to the object (must be a read-write container object).
• key_string [IN] The Exegy key string for the data item being deleted. An Exegy instrument key string takes the following 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 symbol 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 are fixed (XX:BX for baskets, XX:UX for keylists, XX:RX for keylist filters) and the symbol is a user-supplied name for the item.
• turnkey [IN] A turnkey to be associated with the call being made.
• slot [IN] Slot number for the slot holding the data item being deleted. (Or an empty slot may be used.)

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 Specified slot range is not valid.
XTYPE Specified container is not of a compatible type.
XBADSTATE Specified key does not match existing key in a non-empty slot.
XNOTCONNECTED Session not connected.
XBADHANDLE Invalid handle.
XREADONLY Invalid call for read-only field or container.