imgGrab

Usage

rval imgGrab(SESSION_ID sid, void** bufAddr, uInt32 waitForNext);

Purpose

Acquires the most current frame into the specified buffer. Call this function only after calling imgGrabSetup.

Parameters

Name	Type	Direction
sid	SESSION_ID	input
bufAddr	void**	input/output
waitForNext	uInt32	input
rval	Int32	output

Parameter Discussion

sid: valid SESSION_ID.

bufAddr: pointer to a pointer to an area of memory in which to store the image. If bufAddr points to a NULL pointer, this call allocates a buffer, acquires an image, and returns the buffer address in the location specified by bufAddr. If bufAddr points to a non-NULL pointer, this function acquires into that buffer.

waitForNext: if zero, the function returns the most recently acquired image. If non-zero, the function waits for and returns the next acquired image.

Return Value

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