SignaturePad.waitForCapture Method

Module: SignaturePad

Definition

Blocks the calling thread until new capture data is available or the specified timeout period elapses.

This function is useful for synchronizing with the capture process.

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

Parameters

timeout int
in The maximum amount of time (in milliseconds) to wait for new capture data to become available. A value of 0 can be used to wait indefinitely.

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

Returns

bool
Outputs a boolean value indicating whether new capture data is available after the wait period. true if new data is available, false otherwise.

Exceptions

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

Parameters

timeout int
in The maximum amount of time (in milliseconds) to wait for new capture data to become available. A value of 0 can be used to wait indefinitely.

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

Returns

bool
Outputs a boolean value indicating whether new capture data is available after the wait period. true if new data is available, false otherwise.

Exceptions

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

Parameters

timeout int
in The maximum amount of time (in milliseconds) to wait for new capture data to become available. A value of 0 can be used to wait indefinitely.

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

Returns

bool
Outputs a boolean value indicating whether new capture data is available after the wait period. true if new data is available, false otherwise.

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 amount of time (in milliseconds) to wait for new capture data to become available. A value of 0 can be used to wait indefinitely.

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

Returns

boolean
Outputs a boolean value indicating whether new capture data is available after the wait period. true if new data is available, false otherwise.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
int id3DevicesSignaturePad_WaitForCapture (
    ID3_DEVICES_SIGNATURE_PAD hSignaturePad,
    int timeout,
    bool doEvent,
    bool * available)

Parameters

hSignaturePad ID3_DEVICES_SIGNATURE_PAD
in Handle to the SignaturePad object.

timeout int
in The maximum amount of time (in milliseconds) to wait for new capture data to become available. A value of 0 can be used to wait indefinitely.

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

available bool *
out Outputs a boolean value indicating whether new capture data is available after the wait period. true if new data is available, false otherwise.

Returns

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