Sends a node status.
Category: | Node |
Returned data type: | Boolean |
SENDNODESTATUS(status key, statusvalue)
status key
a string representing the name of the status key available value is:
status value
a string representing the value of the status key
returns
Boolean value; true if the SENDNODESTATUS was successful; false otherwise
Note: The SENDNODESTATUS function is applicable only in a process job.
The SENDNODESTATUS function tells the process job engine of the status of the node. If an expression is going to run for a long time it is a good idea for it to send its status. It takes two parameters, a status key, and a status value.
Available keys are:
"__PCT_COMPLETE" // percent complete
"__OVERALL" // overall status (suitable for displaying on the ui with a node)
integer i
for i = 1 to 100
begin
sleep (100)
sendnodestatus ("__PCT_COMPLETE", i)
end