Guardian Procedure Calls Reference Manual (G06.25+)

Guardian Procedure Calls (S)
Guardian Procedure Calls Reference Manual—522629-013
14-168
STOP Procedure
(Superseded by PROCESS_STOP_ Procedure )
error output
INT:ref:1
returns a file-system error number. STOP returns a nonzero value for this
parameter only when it cannot successfully make the request to stop the
designated process. If it makes the request successfully (
error is 0), the
designated process might or might not be stopped depending on the stopmode of
the process and the authority of the caller. (The stopmode of the process can be
changed; hence, a stop request that has inadequate authority to stop the process
is saved by the system and might succeed at a later time.) See Considerations
on
page 14-169.
The following parameters supply completion-code information which consists of
four items: the completion code, a numeric field for additional termination
information, a subsystem identifier in SPI format, and an ASCII text string. These
items have meaning in the call to STOP only when a process is stopping itself.
compl-code input
INT:value
compl-code is the completion code to be returned to the creator process in the
STOP system message and, for a terminating OSS process, in the OSS
termination status. Specify this parameter only if the calling process is abending
itself and you want to return a completion code value other than the default value
of 0. See Appendix C, Completion Codes
for a list of completion codes.
termination-info input
INT:value
Can be provided as an option by the calling process if it is a subsystem process
that defines Subsystem Programmatic Interface (SPI) error numbers. If supplied,
this parameter should be the SPI error number that identifies the error that caused
the process to stop itself. For more information on the SPI error numbers and
subsystem IDs, see the
SPI Programming Manual. If termination-info is not
specified, this field is zero.
The following parameters should be supplied to identify the subsystem ID that
defines the SPI error number.
spi-ssid input
INT .EXT:ref:6
is a subsystem ID (SSID) that identifies the subsystem defining the
termination-info. The format and use of the SSID is described in the SPI
Programming Manual.