imgSessionCopyBufferByNumber
Usage
rval imgSessionCopyArea (SESSION_ID boardid, uInt32 bufNumber, void* userBuffer, IMG_OVERWRITE_MODE overwriteMode, uInt32* copiedNumber, uInt32* copiedIndex);
Purpose
Copies an area of a session buffer to a user-specified buffer.
Parameters
| Name | Type | Direction |
| boardid | SESSION_ID | input |
| bufNumber | uInt32 | input |
| userBuffer | void* | input |
| overwriteMode | IMG_OVERWRITE_MODE | input |
| copiedNumber | uInt32* | input |
| copiedIndex | uInt32* | input |
Parameter Discussion
boardid: valid SESSION_ID.
bufNumber: cumulative buffer number.
userBuffer: image to plot.
overwriteMode: gets/sets the overwrite mode, used to determine acquisition when an image transfer cannot be completed due to an overwritten internal buffer.
copiedNumber: actual cumulative number provided.
copiedIndex: actual cumulative index provided.
Return Value
This function returns 0 on success. On failure, this function returns an error code. For information about the error code, call imgShowError.