Search:

As defined in xcapi.h

Description:

Sets the value of one or more elements in an array field. When multiple elements are set, they must be contiguous. Note that indexing notation may be appended to the field ID if the initial element to be set is other than the zeroeth (see the fieldID parameter description).

Restrictions:

• Can only be called on settable array fields.

Parameters:

• object [IN] The handle to the object (must be for an object type listed in the table above).
• slot [IN] Slot number of the targeted item within the object. (The item whose array field is being set.) Note that if a container level array field is being set, the special slot constant XC_CONTAINER must be used.
• fieldID [IN] ID of the array field to be written to. An index number may be appended to the Field ID, thereby specifying a starting point in the array other than the zeroeth element. Thus "fieldID+n", where n is the index number of the initial element to be written to. (Total number of elements to be written to is specified as the elmcnt.)
• ibuf [IN] Address of input data buffer.
• elmsiz [IN] Size of each element in the input data buffer (in bytes).
• elmcnt [IN/OUT] Number of elements supplied (number of elements actually set is returned).

Returns:

An xerr type indicating the status of the operation.

Common error codes:

XSUCCESS The operation completed successfully.
XINVAL An invalid parameter was supplied.
XMOREDATA Successful completion, but more input elements were supplied than were present in the container (or than could be added).
XBADSLOT Invalid slot number.
XBADFIELD Invalid field.
XNOTCONNECTED Session not connected.
XBADSIZE Input buffer smaller than size of field to be modified.
XBADHANDLE Invalid handle.
XREADONLY Invalid call for read-only field or container.