imgSessionCopyBuffer

Usage

rval imgSessionCopyBuffer(SESSION_ID sid, uInt32 bufferIndex, void* buffer, uInt32 waitForNext);

Purpose

Copies session image data to a user buffer.

Parameters

Name	Type	Direction
sid	SESSION_ID	input
bufferIndex	uInt32	input
buffer	void*	input
waitForNext	uInt32	input
rval	Int32	output

Parameter Discussion

sid: valid SESSION_ID.

bufferIndex: valid buffer list index from which to copy.

buffer: points to an area of memory to receive the copy.

waitForNext: if zero, the function copies immediately. If non-zero, the function waits until the current acquisition is complete before copying.

Return Value

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