Search:

As defined in xcapi.h

Description:

Suspends event notification callbacks for one or more slots in a container object. No events will fire for a suspended slot unless xcResumeCallbacks() is subsequently called on it. Note that the associated content items in the container object continue to be updated in response to messages from the Exegy appliance, but the calling application is not notified of the updates. To suspend callbacks for all slots in the container, pass in NULL for the slots parameter, and 0 for the count.

Restrictions:

• May not be called from within a callback function for a RT-ExchangeStream, RT-PriceBookExchangeStream or RT-OrderBookExchangeStream container.
• Belongs to the Mutually Exclusive function set.
• Not valid for session or event objects (i.e., for container objects only).

Parameters:

• object [IN] Handle to the container object.
• slots [IN] The address of an array of one or more slot numbers, indicating which items/slots in the object are to have their event notification callbacks suspended. To suspend callbacks for all slots/items in the object, set slots to NULL and count to 0.
• count [IN] The number of slots to be suspended.

Returns:

An xerr type indicating the status of the operation.

Common error codes:

XSUCCESS The operation completed successfully.
XINVAL An invalid parameter was supplied.
XBADHANDLE Invalid handle.
XTHREAD Called from an invalid thread.
XBADSLOT Invalid slot number.
XNOTSUP Not supported for the object (e.g., callbacks cannot be suspended for a STATIC object).