STOP_LS

STOP_LS requests the deactivation of a link station. It is returned specifying whether the link was stopped successfully. STOP_LS can also be used to disable remote activation of a link station or to disable activation on demand of a link station. STOP_LS is also used to instruct the Program to stop automatically retrying the activation of any link station.

VCB Structure

typedef struct stop_ls
{
        unsigned short  opcode;         /* verb operation code          */
        unsigned char   reserv2;        /* reserved                     */
        unsigned char   format;         /* format                       */
        unsigned short  primary_rc;     /* primary return code          */
        unsigned long   secondary_rc;   /* secondary return code        */
        unsigned char   stop_type;      /* stop type                    */
        unsigned char   ls_name[8];     /* name of link station         */
        unsigned char   disable;        /* whether the link is disabled */
        unsigned char   reserved[3];    /* reserved                     */
} STOP_LS;

Supplied Parameters

The application supplies the following parameters:
opcode
AP_STOP_LS
format
Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.
stop_type
Manner in which the link station should be stopped.
AP_ORDERLY_STOP
Node should perform cleanup operations before stopping the link station.
AP_IMMEDIATE_STOP
Node should stop the link station immediately.
ls_name
Name of link station to be stopped. This is an 8-byte string in a locally displayable character set. All 8 bytes are significant and must be set. The value of ls_name must match that on the DEFINE_LS verb.
disable
This indicates whether remote activation or activation on demand of this link station should be disabled. If set to AP_NO, then the link station is returned to the state given by the values of auto_act_supp and disable_remote_act from the DEFINE_LS verb. Otherwise, the following values are possible (and can be ORed together).
AP_AUTO_ACT
The link cannot be reactivated on demand by the local node.
AP_REMOTE_ACT
The link cannot be activated by the remote node. For a link configured with disable_remote_act set to AP_YES, this bit is ignored (activation by a remote node is always disabled by STOP_LS).

If the disable field is not set to AP_NO, then STOP_LS can be issued for a link that is not active or that is in the process of deactivating, for the purpose of setting the disable field.

Returned Parameters

If the verb executes successfully, the Program returns the following parameter:
primary_rc
AP_OK
If the verb does not execute because of a parameter error, the Program returns the following parameters:
primary_rc
AP_PARAMETER_CHECK
secondary_rc
AP_UNRECOGNIZED_DEACT_TYPE

AP_LINK_NOT_DEFD

If the verb does not execute because of a state error, the Program returns the following parameters:
primary_rc
AP_STATE_CHECK
secondary_rc
AP_LINK_DEACT_IN_PROGRESS
If the verb does not execute because it was canceled, the Program returns the following parameter:
primary_rc
AP_CANCELLED
If the verb does not execute because the node has not yet been started, the Program returns the following parameter:
primary_rc
AP_NODE_NOT_STARTED
If the verb does not execute because the node is stopping, the Program returns the following parameter:
primary_rc
AP_NODE_STOPPING
If the verb does not execute because of a system error, the Program returns the following parameter:
primary_rc
AP_UNEXPECTED_SYSTEM_ERROR