SET_TP_PROPERTIES

SET_TP_PROPERTIES sets attributes associated with the TP.

VCB Structure

typedef struct set_tp_properties
{
  unsigned short  opcode;          /* verb operation code            */
  unsigned char   opext;           /* verb extension code            */
  unsigned char   format;          /* format                         */
  unsigned short  primary_rc;      /* primary return code            */
  unsigned long   secondary_rc;    /* secondary return code          */
  unsigned char   tp_id[8];        /* TP identifier                  */
  unsigned char   set_prot_id;     /* set protected LUW identifier   */
  unsigned char   new_prot_id;     /* new protected LUW identifier   */
  unsigned char   prot_id[26];     /* protected LUW identifier       */
  unsigned char   set_unprot_id;   /* set unprotected LUW identifier */
  unsigned char   new_unprot_id;   /* new unprotected LUW identifier */
  unsigned char   unprot_id[26];   /* unprotected LUW identifier     */
  unsigned char   set_user_id;     /*                                */
  unsigned char   set_password;    /*                                */
  unsigned char   user_id[10];     /*                                */
  unsigned char   new_password[10];/*                                */
} SET_TP_PROPERTIES;

Supplied Parameters

The TP supplies the following parameters to Personal Communications:
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.
opext
AP_BASIC_CONVERSATION
format
Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.
set_prot_id
Specifies whether the protected Logical Unit of Work identifier should be set.
  • AP_YES
  • AP_NO
new_prot_id
Specifies whether Personal Communications should generate a new protected Logical Unit of Work identifier. Otherwise, prot_id is used to set the protected LUW identifier. Reserved if set_prot_id is set to AP_NO.
  • AP_YES
  • AP_NO
The prot_id structure specifies the new protected LUW identifier if set_prot_id is set to AP_YES and new_prot_id is set to AP_NO. Otherwise this structure is reserved.
prot_id.fq_lu_name_len
Length of fully qualified LU name associated with Logical Unit of Work.
prot_id.fq_lu_name
Fully qualified LU name associated with Logical Unit of Work. This name is up to 17 bytes long. It is composed of 2 type A EBCDIC character strings concatenated by an EBCDIC dot. (Each name can have a maximum length of 8 bytes with no embedded blanks. If the network ID is not present, then omit the dot). If the name length is less than 17 bytes, the instance and sequence fields must follow the name immediately (note this means instance and sequence should not be copied into the fields of LUW_ID_OVERLAY structure).
prot_id.instance
Logical Unit of Work instance number. This is a binary string of length 6 bytes.
prot_id.sequence
Logical Unit of Work sequence number. This is a binary string of length 2 bytes.

If prot_id.fq_lu_name_len is less than 17, prot_id must be right padded with EBCDIC blanks (after instance and sequence).

set_unprot_id
Specifies whether the unprotected Logical Unit of Work identifier should be set.
  • AP_YES
  • AP_NO
new_unprot_id
Specifies whether Personal Communications should generate a new unprotected Logical Unit of Work identifier. Otherwise, unprot_id is used to set the protected LUW identifier. Reserved if set_unprot_id is set to AP_NO.
  • AP_YES
  • AP_NO
The unprot_id structure specifies the new unprotected LUW identifier if set_unprot_id is set to AP_YES and new_unprot_id is set to AP_NO. Otherwise this structure is reserved.
unprot_id.fq_lu_name_len
Length of fully qualified LU name associated with Logical Unit of Work.
unprot_id.fq_lu_name
Fully qualified LU name associated with Logical Unit of Work. This name is up to 17 bytes long. It is composed of 2 type A EBCDIC character strings concatenated by an EBCDIC dot. (Each name can have a maximum length of 8 bytes with no embedded blanks. If the network ID is not present then omit the dot). If the name length is less than 17 bytes, the instance and sequence fields must follow the name immediately (note this means instance and sequence should not be copied into the fields of LUW_ID_OVERLAY structure).
unprot_id.instance
Logical Unit of Work instance number. This is a binary string of length 6 bytes.
unprot_id.sequence
Logical Unit of Work sequence number. This is a binary string of length 2 bytes.

If unprot_id.fq_lu_name_len is less than 17, unprot_id must be right padded with EBCDIC blanks (after instance and sequence).

set_user_id
Specifies whether the user_id field should be set.
  • AP_YES
  • AP_NO
set_password
Specifies whether the new_password field should be set.
  • AP_YES
  • AP_NO
user_id
If set_user_id is set to AP_YES, it specifies the new user id. Otherwise this field is reserved.
new_password
If set_password is set to AP_YES, it specifies the new password. Otherwise this field is reserved.

Note: If an ALLOCATE or SEND_CONVERSATION specifies a security type of NAP_SAME, but does not specify a user ID and password specified on a previous SET_TP_PROPERTIES verb (if any) are used. If the ALLOCATE or SEND_CONVERSATION do carry a user ID and password, then these are always used in preference to any which may have been specified on the SET_TP_PROPERTIES verb.

Returned Parameters

If the verb executes successfully, Personal Communications returns the following parameters:
primary_rc
AP_OK
If the verb does not execute because of a parameter error, Personal Communications returns the following parameters:
primary_rc
AP_PARAMETER_CHECK
secondary_rc
AP_BAD_TP_ID
The conditions generating the following possible primary return codes (primary_rc) and indented secondary return codes (secondary_rc) are described in APPC Common Return Codes.
  • AP_TP_BUSY
  • AP_UNEXPECTED_SYSTEM_ERROR