imgSetBufferElement2

Download PDF

Usage

rval imgSetBufferElement2(BUFLIST_ID bid, uInt32 element, uInt32 itemType, …);

Sets the value for a specified itemType for a buffer in a buffer list.

Name	Type	Direction
bid	BUFLIST_ID	input
element	uInt32	input
itemType	uInt32	input
…	variable argument	Data is passed by value. The data type should match the expected item type.
rval	Int32	output

bid: valid BUFLIST_ID variable.

element: element number of the buffer list item to modify.

itemType: describes the parameter of the element to set, as specified by the following constants:

IMG_BUFF_ADDRESS	Specifies the buffer address portion of a buffer list element.
IMG_BUFF_CHANNEL	Specifies the channel from which to acquire an image.
IMG_BUFF_COMMAND	Specifies the command portion of a buffer list element.
IMG_BUFF_SIZE	Specifies the size portion of a buffer list element (the buffer size). Required for user-allocated buffers.
IMG_BUFF_SKIPCOUNT	Specifies the skip count portion of a buffer list element.

This function returns 0 on success. On failure, this function returns an error code. For information about the error code, call imgShowError.

Note Refer to Constants for valid element and command types.

Was this information helpful?