SPAWN()

CA-GSS Statements and Commands › GSS Extended Functions › IO Functions › Number, String, and Variable Functions › System Information Functions › SPAWN()

SPAWN()

Use the SPAWN() function to start the execution of another IMOD task. Spawned IMODs run concurrently with the spawning IMOD task.

Important! Do not create a situation where an IMOD task spawns itself. An unlimited number of IMOD tasks may be created, swamping the ISERVE address space.

Syntax

The SPAWN() function has this syntax:

imod_id = (SPAWN,imodname,[{COPYQ|NEWQ|PASSQ}],[args])

Arguments

The SPAWN() function takes these arguments:

imod_id	ID assigned to the new IMOD task. This IMOD ID is a unique number that can be used to reference an executing IMOD task. It is used to access the IMOD task's stacks externally and as an argument in the command CANCEL IMOD.
imodname	Name of the IMOD to be executed. This IMOD must be marked as CALLABLE by including the #CALLABLE compiler directive in the IMOD's source code.
COPYQ	Starts with a copy of the current stack. If NEWSTACK has been used, only the current stack is copied.
NEWQ	Starts with a new, empty stack. This is the default.
PASSQ	Transfers the existing stack to the new IMOD. If NEWSTACK has been used, only the current stack is transferred.
args	Text string, to be passed to the spawned task as an initial argument string.

Usage Notes

If you want a value returned from another IMOD, use CALL instead of SPAWN().
If an IMOD that was triggered from a WTO spawns another IMOD, the WTO's ILOG routing code, if any, is inherited. This may cause multiple copies of the WTO text to be recorded on the ILOG. If this is not desirable, use IROUTE() to suppress ILOG recording of either the original or spawned message text.

Return Codes

The SPAWN() function produces these return codes:

40 INCORRECT CALL TO ROUTINE (NOT CALLABLE)

40 INCORRECT CALL TO ROUTINE (NOT ACTIVE)

40 INCORRECT CALL TO ROUTINE (NOT ALLOWED)

101 - 103 ARG n MISSING OR INVALID

121 REQUESTED IMOD NOT FOUND

Example

queue 'Some data to work on'     /* Get data ready  */
spawn(async_work,'PASSQ') == '00000016'
                                 /* Returns IMOD internal name */

Tell Technical Publications how we can improve this information