OSI/MHS Management Programming Manual

Commands and Responses
OSI/MHS Management Programming Manual—424824-001
5-282
STOP APPL
ZCOM-TKN-SEL-SUMSTATE
is described in the SPI Common Extensions Manual.
ZCOM-TKN-CMD-POWER
is described in the SPI Common Extensions Manual. The possible values are:
NORMAL
Stop the application name only if the MS application name is not currently in
use (logged on). This is the default value.
FORCED
Stop the application even if an MS application name is use (logged on). The
application will receive an error the next time it attempts to access the message
store or use any messaging function associated with the application name.
Tokens in Response Buffer
ZSPI-TKN-DATALIST
introduces a data list, as described in the SPI Programming Manual; the final
ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response
tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0.
ZCOM-TKN-OBJTYPE
ZCOM-TKN-OBJNAME
are described in the SPI Common Extensions Manual.
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
are described in the SPI Programming Manual.
Operational Notes
•
STOP APPL is a sensitive command.
•
The STOPPED state disallows application logons with MS application names.
When the application name is in the STOPPED state, incoming messages for the MS
application are rejected with an NDN.
•
When the application is logged on, it can not be stopped without the modifier
ZCOM-TKN-CMD-POWER FORCED. The application is considered to be logged
on until a LOGOFF indication is received by the MHS.
•
The application must be in the STOPPED state for configuration changes.