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.

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

An error has occurred during Devices Library execution.