SignalChild Method (RUNTIME)

PLB Web Only, 9.8

The SignalChild method generates a $CHILDSIG event in a second PWS child process. This method can also generate a $CHILDSIG event by one PWS child process to the same PWS child process (i.e., itself). The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A RUNTIME object.

return

Optional. A Character String Variable that returns the current PWS child process identification string.

identifier

Required. A Character String Variable that contains a valid target PWS child process identification.

options

Optional. A Numeric variable or decimal number that invokes special behaviors for the method.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. The ZERO flag state is set to be TRUE if the {return} value is zero.

2. The OVER flag is set if the {return} numeric variable is too small to receive the full numeric result value.

3. The EOS flag is always cleared.

4. The optional {options} values changes the execution behavior of the SignalChild method as follows:

 

 

Value	Description
0	The default value which causes the current PWS child process to generate\invoke the $CHILDSIG event for the PWS child process identified by the {identifier} child process identification string.
1	The SignalChild method resets $CHILDSIG generation bit for the PWS child process identified by the {identifier} child process identification string.
2	The SignalChild method checks PWS state flags for the PWS child process identified by the {identifier} identification string. If the PWS child process exists and available\active, the {return} value is returned as zero. Otherwise, the {return} value is returned as one.

 

5. The PWS child process identification string that is used in the {identifier} parameter must be formatted as follows:

 

     IDnnnnnnnnn

 

6. The {return} value is zero if the SignalChild method executes successfully with the following conditions. Otherwise, the {return} value is one which indicates that one of the following conditions failed.

 

1. The PWS child process specified by the {identifier} currently exists and is found.

2. The {options} parameter value is zero, one, or two which is required to manage the $CHILDSIG event operations.

 

7. When the $CHILDSIG event is registered and dispatched by the target child process specified by the {identifier} parameter, the target child process only executes the $CHILDSIG event once. Also, the generation of the target child process $CHILDSIG event is totally asynchronous to the action(s) of executing the SignalChild method.

8. There is no fast event support for the $CHILDSIG event.

See Also: RUNTIME, RUNTIME Methods, Method Syntax