imgSnap

Usage

rval imgSnap(SESSION_ID sid, void** bufAddr);

Purpose

Acquires a single image.

Parameters

Name	Type	Direction
sid	SESSION_ID	input
bufAddr	void**	input/output
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.

Return Value

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