Search:

As defined in xcapi.h

Description:

Removes one or more specified items from persistent storage on the Exegy appliance. If multiple items are being deleted, the specified slot number indicates the first slot in a contiguous block of slots in the read-write or write-only object. Each targeted slot must either be empty, or must contain the same data item as the corresponding element in the slot context array.

Note that 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.

When multiple items are deleted in a single call, each delete operation is executed independently (per item). If the function returns XSUCCESS, the caller can expect at least one callback invocation (event) for each item and its corresponding slot in the object. (Note that the caller may receive a mix of "good" and "bad" statuses in the individual event objects associated with each callback invocation.)

Upon successful completion of the delete operation for each slot, any item data in the 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, the slots in those objects associated with that data item are cleared, and the object stops 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).
• contexts [IN] Array of one or more slot contexts, identifying the item(s) targeted for deletion. (A slot context includes the XC_KEY and the user-specified Exegy turnkey that were associated with the data item when it was placed in persistent storage.) 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 (i.e., items to be deleted) passed in.
• slot [IN] The slot number for a slot in the read-write object. The slot must be empty or must contain the data item being deleted. Note that if multiple items are being deleted in a single call, the slot number passed in represents the first slot in a contiguous block of slots to be associated with the deletions. These slots must either be empty or must each contain the same data item as the corresponding element in the slot context array. Passing in XC_NEXT_AVAILABLE_SLOT will cause the same empty slot (if one is available) to be used for deleting all items specified in the contexts parameter.

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.