STOP_PORT

STOP_PORT requests that a port be stopped. It is returned specifying whether the port was stopped successfully. STOP_PORT is also used to instruct the Program to stop automatically retrying the activation of any link stations on the port.

VCB Structure

typedef struct stop_port
{
        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   port_name[8];   /* name of port          */
} STOP_PORT;

Supplied Parameters

The application supplies the following parameters:
opcode
AP_STOP_PORT
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 port should be stopped.
AP_ORDERLY_STOP
Node should perform cleanup operations before stopping the port.
AP_IMMEDIATE_STOP
Node should stop the port immediately.
port_name
Name of port to be stopped. This is an 8-byte string in a locally displayable character set, which must match that on the DEFINE_PORT verb.

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_INVALID_PORT_NAME

AP_UNRECOGNIZED_DEACT_TYPE

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_STOP_PORT_PENDING
If the verb does not execute because it has been 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