SetupNCPolling()

Description

SetupNCPolling() is used to setup a network counter polling.

Call Signature

int SetupNCPolling ( function user_prog_func [, char ptr arg_pointer] )

Return Value

int

1 is returned if polling was correctly setup, 0 otherwise.

Arguments

function user_prog_func:

A user defined function with three arguments that will be called when each progress update is recieved. If 'ProgressCounter' is given, the default progress counter is used and no user function needs to be defined.

[ char ptr arg_pointer ]:

Optional Pointer to a character array, to be passed to the user progress function. The length of the array is unknown by EASI, and assumed to be a very large value. f$len() should not be used to determine its length.

Remarks

This is used to capture the progress counter output of a separate process such as an EASI task. The user progress function must be defined when SetupNCPolling() is called. The user progress function takes three arguments, the percentage completion as a fractional value between 0 and 1, a string message, and a character pointer. The user progress function should return 1 if the computation should continue, and 0 to request termination.

Example

 define function MyProgressFunction( completion, message, arg )
     print "Completion is %d\n", completion
     return( 1 )
 enddefine

 call SetupNCPolling( MyProgressFunction, NULL )

 run IIIAVG

See also

Inter-process communication