Previous Page Contents Page Next Page

3.6 SET_TP_PROPERTIES

The SET_TP_PROPERTIES verb enables the application to set properties of the local TP, which are used when allocating new conversations for the TP. It provides access to the following properties:

3.6.1 VCB Structure: SET_TP_PROPERTIES

The definition of the VCB structure for the SET_TP_PROPERTIES verb is as follows:

typedef struct set_tp_properties
{
  AP_UINT16         opcode;
  unsigned char     opext;                 /* Reserved      */
  unsigned char     format;                /* Reserved      */
  AP_UINT16         primary_rc;
  AP_UINT32         secondary_rc;
  unsigned char     tp_id[8];
  unsigned char     set_prot_id;
  unsigned char     new_prot_id;
  LUWID_OVERLAY     prot_id;
  unsigned char     set_unprot_id;
  unsigned char     new_unprot_id;
  LUWID_OVERLAY     unprot_id;
  unsigned char     set_user_id;
  unsigned char     set_password;
  unsigned char     user_id[10];
  unsigned char     new_password[10];
} SET_TP_PROPERTIES;

typedef struct luwid_overlay
{
  unsigned char    fq_length;
  unsigned char    fq_luw_name[17];
  unsigned char    instance[6];
  unsigned char    sequence[2];
} LUWID_OVERLAY; 

3.6.2 Supplied Parameters

The TP supplies the following parameters to APPC:

opcode

AP_SET_TP_PROPERTIES

tp_id

Identifier for the local TP.

The value of this parameter was returned by the TP_STARTED verb in the invoking TP or by RECEIVE_ALLOCATE in the invoked TP.

set_prot_id

Specifies whether APPC is to modify the protected Logical Unit of Work identifier. Possible values are:

AP_YES

Modify the protected LUWID for this TP.

AP_NO

Leave the protected LUWID unchanged.

new_prot_id

Specifies whether APPC should generate a new protected Logical Unit of Work identifier, or to use the one specified on this verb. This parameter is reserved if set_prod_id is set to AP_NO. Possible values are:

AP_YES

Generate a new protected LUWID.

AP_NO

Set the TP's protected LUWID to the one supplied on this verb.

prot_id

If set_prot_id is set to AP_YES and new_prot_id is set to AP_NO, this structure specifies the new protected LUWID for the TP; otherwise this structure is reserved. The structure contains the following parameters:

prot_id.fq_length

The length (1-17 bytes) of the fully qualified LU name associated with the Logical Unit of Work (the LU name itself is specified by the following parameter)

prot_id.fq_luw_name

The fully qualified LU name associated with the Logical Unit of Work. This name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces. It consists of a network ID of 1-8 A-string characters, an EBCDIC dot (period) character, and an LU name of 1-8 A-string characters.

prot_id.instance

The instance number associated with the Logical Unit of Work (a 6-byte binary number).

prot_id.sequence

The sequence number of the current segment of the Logical Unit of Work (a 2-byte binary number).

set_unprot_id

Specifies whether APPC is to modify the unprotected Logical Unit of Work identifier. Possible values are:

AP_YES

Modify the unprotected LUWID for this TP.

AP_NO

Leave the unprotected LUWID unchanged.

new_unprot_id

Specifies whether APPC should generate a new unprotected Logical Unit of Work identifier, or to use the one specified on this verb. This parameter is reserved if set_unprot_id is set to AP_NO. Possible values are:

AP_YES

Generate a new unprotected LUWID.

AP_NO

Set the TP's unprotected LUWID to the one supplied on this verb.

unprot_id

If set_unprot_id is set to AP_YES and new_unprot_id is set to AP_NO, this structure specifies the new unprotected LUWID for the TP; otherwise this structure is reserved. The structure contains the following parameters:

unprot_id.fq_length

The length (1-17 bytes) of the fully qualified LU name associated with the Logical Unit of Work (the LU name itself is specified by the following parameter)

unprot_id.fq_luw_name

The fully qualified LU name associated with the Logical Unit of Work. This name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces. It consists of a network ID of 1-8 A-string characters, an EBCDIC dot (period) character, and an LU name of 1-8 A-string characters.

unprot_id.instance

The instance number associated with the Logical Unit of Work (a 6-byte binary number).

unprot_id.sequence

The sequence number of the current segment of the Logical Unit of Work (a 2-byte binary number).

set_user_id

Specifies whether APPC is to modify the user ID. Possible values are:

AP_YES

Modify the user ID for this TP.

AP_NO

Leave the user ID unchanged.

set_password

Specifies whether APPC should modify the password associated with the new_password parameter. Possible values are:

AP_YES

APPC should modify the password.

AP_NO

APPC should not modify the password.

user_id

If set_user_id is set to AP_YES, this parameter specifies the new user ID; otherwise it is reserved.

new_password

If set_password is set to AP_YES, this parameter specifies the new password; otherwise it is reserved.

3.6.3 Returned Parameters

After the verb executes, APPC returns parameters to indicate whether the execution was successful and, if not, to indicate the reason the execution was not successful.

Successful Execution

If the verb executes successfully, APPC returns the following parameters:

primary_rc

AP_OK

prot_id

If set_prot_id and new_prot_id are both set to AP_YES, this structure specifies the new protected LUWID for the TP, as generated by APPC. The structure contains the following parameters:

prot_id.fq_length

The length (1-17 bytes) of the fully qualified LU name associated with the Logical Unit of Work (the LU name itself is specified by the prot_id.fq_luw_name parameter)

prot_id.fq_luw_name

The fully qualified LU name associated with the Logical Unit of Work. This name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces. It consists of a network ID of 1-8 A-string characters, an EBCDIC dot (period) character, and an LU name of 1-8 A-string characters.

prot_id.instance

The instance number associated with the Logical Unit of Work (a 6-byte binary number).

prot_id.sequence

The sequence number of the current segment of the Logical Unit of Work (a 2-byte binary number).

unprot_id

If set_unprot_id and new_unprot_id are both set to AP_YES, this structure specifies the new unprotected LUWID for the TP, as generated by APPC. The structure contains the following parameters:

unprot_id.fq_length

The length (1-17 bytes) of the fully qualified LU name associated with the Logical Unit of Work (the LU name itself is specified by the unprot_id.fq_luw_name parameter)

unprot_id.fq_luw_name

The fully qualified LU name associated with the Logical Unit of Work. This name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces. It consists of a network ID of 1-8 A-string characters, an EBCDIC dot (period) character, and an LU name of 1-8 A-string characters.

unprot_id.instance

The instance number associated with the Logical Unit of Work (a 6-byte binary number).

unprot_id.sequence

The sequence number of the current segment of the Logical Unit of Work (a 2-byte binary number).

Unsuccessful Execution

If the verb does not execute successfully, APPC returns a primary return code parameter to indicate the type of error and a secondary return code parameter to provide specific details about the reason for unsuccessful execution.

Parameter Check

If the verb does not execute because of a parameter error, APPC returns the following parameters:

primary_rc

AP_PARAMETER_CHECK

secondary_rc

Possible values are:

AP_BAD_TP_ID

The value of tp_id did not match a TP identifier assigned by APPC.

AP_INVALID_FORMAT

The reserved parameter format was set to a nonzero value.

AP_SYNC_NOT_ALLOWED

The application issued this verb within a callback routine, using the synchronous APPC entry point. Any verb issued from a callback routine must use the asynchronous entry point.

State Check

No state check errors occur for this verb.

Other Conditions

If the verb does not execute because other conditions exist, APPC returns primary return codes (and, if applicable, secondary return codes). For information about these return codes, see Common Return Codes.

Possible values are:

primary_rc

AP_COMM_SUBSYSTEM_ABENDED
AP_INVALID_VERB
AP_TP_BUSY
AP_UNEXPECTED_SYSTEM_ERROR

APPC does not return secondary return codes with these primary return codes.

3.6.4 State When Issued

The conversation can be in any state when the TP issues this verb.

3.6.5 State Change

The conversation state does not change for this verb.

3.6.6 Usage and Restrictions

For TPs that use Syncpoint functions, when the local application changes the protected LUWID, the Syncpoint Manager is responsible for sending the appropriate PS header to the partner application to inform it of the new protected LUWID. Similarly, when the Syncpoint Manager receives a PS header containing a new protected LUWID, it must issue SET_TP_PROPERTIES to inform the local LU of the new LUWID.

Previous Page Contents Page Top of Page Next page