GET_TP_PROPERTIES

GET_TP_PROPERTIES returns attributes associated with the transaction program.

VCB Structure

typedef struct get_tp_properties
{
 unsigned short   opcode;               /* verb operation code            */
 unsigned char    opext;                /* verb extension code            */
 unsigned char    format;               /* format                         */
 unsigned char    reserv2[2]            /* verb format                    */
 unsigned short   primary_rc;           /* primary return code            */
 unsigned long    secondary_rc;         /* secondary return code          */
 unsigned char    tp_id[8];             /* TP identifier                  */
 unsigned char    tp_name[64];          /* TP name                        */
 unsigned char    lu_alias[8];          /* LU alias                       */
 luw_id_overlay   luw_id;               /* LUW identifier       */
 unsigned char    fqlu_name[17];        /* fully qualified LU name        */
 unsigned char    reserv3[10];          /* reserved                       */
 unsigned char    user_id[10];          /* user id                        */
} GET_TP_PROPERTIES;
typedef struct luw_id_overlay
{
 unsigned char    fqlu_name_len;        /* fully qualified LU name length */
 unsigned char    fqlu_name[17];        /* fully qualified LU name        */
 unsigned char    instance[6];          /* instance number                */
 unsigned char    sequence[2];          /* sequence number                */
} LUW_ID_OVERLAY;

Supplied Parameters

The transaction program supplies the following parameters to Personal Communications:
opcode
AP_GET_TP_PROPERTIES
tp_id
Identifier for the local transaction program. The value of this parameter was returned by the TP_STARTED verb in the invoking transaction program or by RECEIVE_ALLOCATE in the invoked transaction program.
opext
AP_BASIC_CONVERSATION
format
Identifies the format of the VCB. Set this field to one to specify the version of the VCB listed above.

Returned Parameters

If the verb executes successfully, Personal Communications returns the following parameters:
primary_rc
AP_OK
tp_name
Name of the local transaction program, that is, the transaction program issuing this verb. Personal Communications does not check the character set of this field.
lu_alias
Alias of the local LU associated with the transaction program. This is an 8-byte string in a locally displayable character set. All 8 bytes are significant and must be set.
The luw_id field is a Logical Unit of Work identifier associated with unprotected conversations (conversations with sync_level of AP_NONE or AP_CONFIRM_SYNC_LEVEL). The luw_id_overlay contains the following parameters:
luw_id_overlay.fqlu_name_len
Length of fully qualified LU name associated with Logical Unit of Work.
luw_id_overlay.fqlu_name
Fully qualified LU name associated with Logical Unit of Work. This name is up to 17 bytes long and is right-padded with EBCDIC blanks. It is composed of two 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, instance and sequence immediately follow the name (note that this means the fields of the LUW_ID_OVERLAY structure cannot be used to access either instance or sequence).
luw_id_overlay.instance
Logical unit of work instance number. This is a binary string of length 6 bytes.
luw_id_overlay.sequence
Logical unit of work sequence number. This is a binary string of length 2 bytes.
If luw_id_overlay.fqlu_name_len is less than 17, luw_id_overlay is right padded with EDCDIC blanks (after instance and sequence).
fqlu_name
Fully qualified name of the local LU associated with the transaction program. This name is 17 bytes long and is right-padded with EBCDIC blanks. It is composed of two 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.)
user_id
User ID of the initiator of the transaction. This is a 10-byte type-AE EBCDIC character string, padded to the right with EBCDIC spaces.
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) are described in APPC Common Return Codes.
  • AP_TP_BUSY
  • AP_UNEXPECTED_SYSTEM_ERROR