Search:

As defined in xcapi.h

Description:

Sets a field to a specified value. The call is used in three situations: (1) to set required field values in a data item before submitting that item to the Exegy appliance for persistent storage or temporary use; (2) to set a user preference for a particular data view prior to making an xcRequestItemByString() request on RT-PriceBookSummary; or (3) to set a user preference for market status callbacks in SessionTicker.

Restrictions:

• Can only be called on settable fields.

Parameters:

• object [IN] The handle to the object (must be for one of the object types listed in the table above).
• slot [IN] Slot number of the data item in the object. (The item whose field is being set.) Note that if a container level field is being set, the special slot constant XC_CONTAINER must be used.
• fieldID [IN] ID of field to be written to.
• ibuf [IN] Address of input data buffer.
• ibufsiz [IN] Size of input data buffer (in bytes).

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 Invalid slot number.
XBADFIELD Invalid field.
XNOTCONNECTED Session not connected.
XBADSIZE Input buffer smaller than size of field to be modified.
XBADHANDLE Invalid handle.
XREADONLY Invalid call for read-only field or container.