BarcodeReader.waitForCapture Method

Module: BarcodeReader

Definition

Blocks until new capture data is available or a timeout occurs.

wait_for_capture(self, timeout: int, do_event: bool) -> bool

Parameters

timeout int
in The maximum time to wait for new data.

do_event bool
in Call doEvent() in the wait loop.

Returns

bool
Outputs whether new capture data is available following the wait.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
bool waitForCapture(int timeout, bool doEvent)

Parameters

timeout int
in The maximum time to wait for new data.

doEvent bool
in Call doEvent() in the wait loop.

Returns

bool
Outputs whether new capture data is available following the wait.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public bool WaitForCapture(int timeout, bool doEvent)

Parameters

timeout int
in The maximum time to wait for new data.

doEvent bool
in Call doEvent() in the wait loop.

Returns

bool
Outputs whether new capture data is available following the wait.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public boolean waitForCapture(int timeout, boolean doEvent) throws DevicesException

Parameters

timeout int
in The maximum time to wait for new data.

doEvent boolean
in Call doEvent() in the wait loop.

Returns

boolean
Outputs whether new capture data is available following the wait.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
int id3DevicesBarcodeReader_WaitForCapture (
    ID3_DEVICES_BARCODE_READER hBarcodeReader,
    int timeout,
    bool doEvent,
    bool * available)

Parameters

hBarcodeReader ID3_DEVICES_BARCODE_READER
in Handle to the BarcodeReader object.

timeout int
in The maximum time to wait for new data.

doEvent bool
in Call doEvent() in the wait loop.

available bool *
out Outputs whether new capture data is available following the wait.

Returns

int
An error code.
See id3DevicesError file for the list of possible error codes.