STD.File.WaitDfuWorkunit( dfuwuid [ ,timeout ] [ ,espserverIPport ] )
| dfuwuid | A null-terminated string containing the DFU workunit ID (DFUWUID) for the job to wait for. This value is returned by the "leading-f" versions of the Copy, DKC, SprayFixed, SprayVariable, SprayXML, and Despray FileServices functions. |
| timeout | Optional. An integer value indicating the timeout setting. If omitted, the default is -1. If set to zero (0), execution control returns immediately to the ECL workunit without waiting for the DFU workunit to complete. |
| espserverIPport | Optional. This should almost always be omitted, which then defaults to the value contained in the lib_system.ws_fs_server attribute. When not omitted, it should be a null-terminated string containing the protocol, IP, port, and directory, or the DNS equivalent, of the ESP server program. This is usually the same IP and port as ECL Watch, with "/FileSpray" appended. |
| Return: | WaitDfuWorkunit returns a null-terminated string containing the final status string of the DFU workunit (such as: scheduled, queued, started, aborted, failed, finished, or monitoring). |
The WaitDfuWorkunit function waits for the specified DFU workunit to finish. Typically that workunit will have been launched with its timeout parameter set to zero (0).
Example:
STD.File.WaitDfuWorkunit('D20051108-143758');