imgSessionAbort
Usage
rval imgSessionAbort(SESSION_ID sid, uInt32* bufferIndex);
Purpose
Stops an acquisition immediately. This function clears all acquisition configuration, disassociates the session from the buffer list, and unregisters all acquisition triggers. Prior to starting a new acquisition, the buffer list and any acquisition triggers need to be reassociated with the session via imgSessionConfigure and imgSessionTriggerConfigure2, respectively. Use imgSessionStopAcquisition to stop an acquisition and maintain the current session configuration.
Parameters
| Name | Type | Direction |
| sid | SESSION_ID | input |
| bufferIndex | uInt32* | output |
| rval | Int32 | output |
Parameter Discussion
sid: valid SESSION_ID.
bufferIndex: on return, the function populates bufferIndex with the last available buffer list index.
Return Value
This function returns 0 on success. On failure, this function returns an error code. For information about the error code, call imgShowError.