imgSessionCopyAreaByNumber
- Updated2023-02-21
- 1 minute(s) read
Usage
rval imgSessionCopyAreaByNumber (SESSION_ID boardid, uInt32 bufNumber, uInt32 top, uInt32 left, uInt32 height, uInt32 width, void* userBuffer, uInt32 rowPixels, 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 |
| top | uInt32 | input |
| left | uInt32 | input |
| height | uInt32 | input |
| width | uInt32 | input |
| userBuffer | void* | input |
| rowPixels | uInt32 | input |
| overwriteMode | IMG_OVERWRITE_MODE | input |
| copiedNumber | uInt32* | output |
| copiedIndex | uInt32* | output |
Parameter Discussion
boardid: valid SESSION_ID.
bufNumber: cumulative buffer number.
top: top coordinate of the area to copy.
left: left coordinate of the area to copy.
height: height of the area to copy.
width: width of the area to copy.
userBuffer: image to plot.
rowPixels: number of pixels in each image line of the destination buffer. Passing a zero for this parameter causes the function to ignore the parameter and use the IMG_ATTR_ROWPIXELS attribute instead. Use this parameter for byte alignment or if the image buffer contains a border for image processing.
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 zero on success. On failure, this function returns an error code. For information about the error code, call imgShowError.