Search:

As defined in xcapi.h

Description:

Destroys a specified session or container object and deallocates its associated resources. If a container object is passed in as the parameter, then all slots in that container are removed and the object is destroyed and invalidated. The function waits for the outstanding callbacks (if any) to return prior to executing. If a session object is passed in as the parameter, then the session is disconnected and the object destroyed. In addition, any objects spawned from that session instance are invalidated.

Restrictions:

• This function may not be called from within a callback function.
• Belongs to the Mutually Exclusive function set.
• Note that calling this function on a session object in a session set destroys all session objects within the set.

Parameters:

• object [IN] Handle to object to be destroyed.

Returns:

An xerr type indicating the status of the operation.

Common error codes:

XSUCCESS Successfully destroyed.
XINVAL An invalid parameter was supplied.
XTYPE An invalid object type was specified (e.g., an event object)
XTHREAD Called from any invalid thread.
XBADHANDLE Invalid handle.