SENDNODESTATUS Function

Sends a node status.

Valid in: Only in a process job.
Category: Node
Returned data type: Boolean
Syntax
Required Arguments
Details
Example

Syntax

SENDNODESTATUS("status-key", status-value)

Required Arguments

"status-key"

specifies one of the following strings to indicates the name of the status that is being reported:

_PCT_COMPLETE the percentage complete
OVERALL the overall status, which appears in the application interface as node status

status-value

specifies a string that indicates the value of status-key.

Details

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. The function returns TRUE if the function completes successfully. Otherwise, it returns FALSE.

Example 

integer i
for i = 1 to 100
begin
   sleep (100)
   sendnodestatus ("__PCT_COMPLETE", i)
end
Copyright © SAS Institute Inc. All rights reserved.