Search:

As defined in xcapi.h

Description:

Submits one or more data items to the Exegy appliance system for persistent storage or temporary use.

Prior to calling xcSubmitItemByString(), the xcSetField() function 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 the each slot context (type XC_SLOT_CONTEXT) passed into the call includes an XC_KEY. If the symbol portion of that key is a "long symbol" ( > 20 characters), the Exegy internal binary representation of the key must be used. See "XC_KEY Data Type" and "Working with long symbols" in the appendix of this document for a more detailed discussion of the XC_KEY structure, and a suggested best-practice procedure for obtaining a binary XC_KEY (only necessary for keys that include a long symbol). If the function returns XSUCCESS, the caller can expect at least one callback for each item/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.

Parameters:

• container [IN] handle to the object (must be a READWRITE, WRITEONLY, or STATIC container).
• contexts [IN] Array of information that includes the an Exegy key (type XC_KEY) and an Exegy turnkey for each submitted item. See the note in the function description above for important information about using XC_KEYs which include a long symbol.
• context_count [IN] The number of contexts (items) passed in.
• slot [IN] Number of the first slot of a contiguous block of slots whose items are 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.