CIB pdf toolbox 2 technical documentation
4. Usecases
4.8. Retrieving progess and event information
Property |
Meaning |
Type |
EventCallback |
Address of a callback function which retrieves information about events. The address has to be written as a string, which contains the address as normal number. The callback function needs to have the signature: int EventCallback(uint32_t eventType, const void* eventData, void* userdata);
The return value needs to be 1, if the callback wan’t to return success, otherwise 0. |
Set |
EventCallbackUserdata |
Address of a userdata object which is used inside the callback. The address has to be written as a string, which contains the address as normal number. |
Set |
Progress |
Returning a JSON-description of current progress of the current running JOB. This property can be retrieved from a different thread as the thread in which the current execute is running. The JSON description consists of the Keys “AmountSteps” and “CurrentStep”. AmountSteps defines, how many internal bigger steps are done and the CurrentStep defines how many Steps were already done. |
Get |