START_LS

START_LS requests activation of a link. It is returned as a response specifying whether the link was successfully activated.

See DLC Processes, Ports, and Link Stations for more information about the relationship between DLCs, ports and link stations.

VCB Structure

typedef struct start_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   ls_name[8];     /* name of link station       */
        unsigned char   enable;         /* whether the link is enabled*/
        unsigned char   reserv3[3];     /* reserved                   */
} START_LS;

Supplied Parameters

The application supplies the following parameters:

opcode

AP_START_LS

format

Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.

ls_name

Name of link station to be started. 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.

enable

Set this field to start the link. If this field is set to AP_ACTIVATE, then the link is started. Otherwise, the link is not started, and the following values are possible. These values can be ORed together.

AP_AUTO_ACT: The link can subsequently be activated on demand by the local node. This value is only valid if auto_act_supp was set to AP_YES on the DEFINE_LS verb.
AP_REMOTE_ACT: The link can subsequently be activated by the remote node. This does not alter the defined value of disable_remote_act.

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_LINK_NAME_SPECIFIED

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_PORT_INACTIVE
AP_ACTIVATION_LIMITS_REACHED
AP_PARALLEL_TGS_NOT_SUPPORTED
AP_ALREADY_STARTING
AP_LINK_DEACT_IN_PROGRESS

If the verb does not execute because it was canceled by a subsequent STOP_LS or STOP_PORT before the link became active, the Program returns the following parameters:

primary_rc: AP_CANCELLED
secondary_rc: AP_LINK_DEACTIVATED

If the verb does not execute because the partner could not be found by the link software, the Program returns the following parameters:

primary_rc: AP_LS_FAILURE
secondary_rc: AP_PARTNER_NOT_FOUND

If the verb does not execute because a link error occurred while the link was being established, the Program returns the following parameters:

primary_rc: AP_LS_FAILURE
secondary_rc: AP_ERROR

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