IDS Software Suite 4.96.1
 |
 |
|---|---|
USB 2.0 USB 3.x GigE |
USB 2.0 USB 3.x GigE |
Syntax
INT is_LockSeqBuf (HIDS hCam, INT nMemId, char* pcMem)
Description
is_LockSeqBuf() locks write access to an image memory within a sequence. In the capturing process, locked image memories will be skipped in the sequence list of image memories to be used. This way, you can avoid that image data which are required for further processing will be overwritten by newly captured data. You can lock any number of image memories at the same time.
|
While the driver writes image data to an image memory, a call of is_LockSeqBuf() for this image memory fails. Therefore it is strongly recommended to check the successful locking by is_LockSeqBuf() with the function's return value. |
Using the is_UnlockSeqBuf() function, you can re-enable write access to the image memory.
|
Every successful call of is_LockSeqBuf() must be accompanied by a call of is_UnlockSeqBuf()! |
Input parameters
hCam |
Camera handle |
nMemId |
Number of the image memory to be locked (1…max) or IS_IGNORE_PARAMETER: The image memory will be identified by its starting address only. |
pcMem |
Starting address of the image memory to be locked |
|
nMemId indicates the location in the sequence list, not the memory ID assigned using is_AllocImageMem(). |
nMemId |
pcMem |
Locks based on |
valid |
valid |
pcMem |
valid |
NULL |
nMemId |
IGNORE |
valid |
pcMem |
IGNORE |
NULL |
Error |
Return values
IS_BAD_STRUCTURE_SIZE |
An internal structure has an incorrect size. |
IS_INVALID_CAMERA_HANDLE |
Invalid camera handle |
IS_INVALID_PARAMETER |
One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. |
IS_NO_SUCCESS |
General error message |
IS_SEQ_BUFFER_IS_LOCKED |
The image memory is locked. |
IS_SUCCESS |
Function executed successfully |
Related functions
