Search:

As defined in xcapi.h

Description:

Clears one or more slots in a container object, returning the slot(s) to an EMPTY state. No further event notification callbacks will be made for the content items previously associated with the slot(s), and the cleared slots will be immediately available for reuse. Note: to clear ALL slots in a container, pass in NULL for the slots parameter and 0 for the count.

Restrictions:

• May not be called from within a callback function.
• Belongs to the Mutually Exclusive function set.
• Valid only for container objects.

Parameters:

• object [IN] The handle to the container object.
• slots [IN] The address of an array of one or more slot numbers indicating the slots to be cleared.
• count [IN] The number of slots to be cleared.

Returns:

An xerr type indicating the status of the operation.

Common error codes:

XSUCCESS The operation completed successfully.
XINVAL An invalid parameter was supplied.
XTHREAD Called from an invalid thread.
XBADSLOT Invalid slot number.
XNOTCONNECTED Session not connected.
XBADHANDLE Invalid handle.