XCAPI C API

As defined in xcapi.h

xerr xcCreateContainerWithVectoredEvents(	xhandle session,
	XC_OBJECT_TYPE object_type,
	xhandle *object,
	xcObjectVectoredCallback callback,
	xuint64 turnkey,
	xuint32 max_slots);

Description:

Creates a container object of the specified type and registers a callback function for event notifications. Note that container objects created with this call deliver vectored events (with multiple updates per callback invocation, when appropriate). To create a container object that delivers discrete events only (i.e., one update per callback), use the xcCreateContainer() call.

Restrictions:

May not be called from within a callback function.
Belongs to the Mutually Exclusive function set.

Parameters:

session [IN] The handle to the parent SessionTicker object.
object_type [IN] The XC Object Type ID, specifying the type of container object to create.
object [OUT] The address of an xhandle variable to receive the handle to the newly created container object.
callback [IN] Name of the client callback function to call with event notifications for the object. (May be set to NULL to ignore all events).
turnkey [IN] Opaque, user-specified value which may be of use in identifying the object. (It can be requested from the object.)
max_slots [IN] The number of slots for the new container. Slots are numbered from 0 to (max_slots - 1).

Returns:

An xerr type indicating the status of the creation operation.

Common error codes:

XSUCCESS The container object was successfully created.
XINVAL Invalid parameter, object not created.
XTYPE An invalid object type parameter was supplied.
XTHREAD Called from an invalid thread.
XNOTCONNECTED Session not connected.
XBADHANDLE Invalid handle.