gtpc2ma2C/C++ Language Support User's Guide

General Format

Figure 1 shows the general form for the TPF/APPC functions.

Figure 1. General Form for TPF/APPC Functions


tppc_verbname
 
(parameter_1,
                    .
                    .
                    .
                    parameter_n);

Each function begins with tppc_, followed by the specific verbname, which specifies the function to be executed. This is followed by a set of positional parameters, which means that you must code each parameter in the order shown for the specific function. Parameter values indicate either an option or a pointer to the location of a field. You must specify the options exactly as shown in the function descriptions. Options are indicated by uppercase bold print, such as OPTION. The valid parameters for each TPF/APPC function depend on the verbname you specify.

Table 36 is a summary of the supported verb names and their associated parameters. The table also contains:

More detailed information for each parameter is provided in the individual function descriptions later in this chapter.

Table 36. TPF/APPC Basic Conversation Verbs and Valid Keywords

Verb Name Positional Parameter Passed or Returned Description Architecture Equivalent
activate_on_ confirmation resid Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
  verb Passed This specifies the architecture's verb function to be performed in conjunction with this verb. Valid choices are:
  • AOC_CONFIRM
  • AOC_DEALLOC
  • AOC_P_T_R.
None
  level Passed This specifies the data level that has a block to be passed to the activated program. None
  field Passed This specifies a field that contains data to be passed to the activated program. None
  pgm Passed This specifies the TPF E-type program to be activated when there is data or other information available to satisfy the CONFIRM request. The program specified must be defined in the TPF transaction program name table (TPNT) as TYPE=AOR. None
Note:
The tppc_activate_on_confirmation function is a TPF-only extension to the LU 6.2 architecture. There is no equivalent verb defined in the architecture.
activate_on_ receipt resid Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
  level Passed This specifies the data level that contains a block to be passed to the activated program. None
  field Passed This specifies a field that contains a data to be passed to the activated program. None
  pgm Passed This specifies the TPF E-type program to be activated when there is data or other information available to satisfy the RECEIVE request. The program specified must be defined in the TPF TPNT as TYPE=AOR. None
Note:
The tppc_activate_on_receipt function is a TPF-only extension to the LU 6.2 architecture. There is no equivalent verb defined in the architecture.
allocate resid Returned This specifies where the resource ID is to be returned. The resource ID uniquely identifies this conversation from all others and is used when calling other TPF/APPC functions for this conversation. The resource ID is 4 bytes long. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
  luname Passed This specifies the fully qualified name of the remote LU. LU_NAME
  tpn Passed This specifies the name of the remote transaction program used on this conversation. TPN
  mode Passed This specifies the name used to designate the properties of the session to be allocated. MODE_NAME
  sync Passed This specifies the synchronization level allowed on the allocated conversation. The values ALLOCATE_SYNC_NONE and ALLOCATE_SYNC_CONFIRM provide support for the LU 6.2 architecture's NONE and CONFIRM options, respectively. Only the NONE and CONFIRM options are supported. The TPF system does not support the architecture's SYNCPT option. SYNC_LEVEL
  rcontrol Passed This specifies the condition on which control is returned to the issuing program. The value ALLOCATE_RCONTROL_WSA specifies to return control when a session is allocated for use by the conversation. The value ALLOCATE_RCONTROL_IMM specifies to return control immediately if no contention-winner session is currently active and available. The TPF system does not support the other options defined by the LU 6.2 architecture. RETURN_CONTROL
  type Passed This specifies the type of conversation. The value ALLOCATE_TYPE_BASIC provides support for the BASIC_CONVERSATION option defined by the LU 6.2 architecture. The value ALLOCATE_TYPE_MAPPED provides support for the MAPPED_CONVERSATION option defined by the LU 6.2 architecture. TYPE
  pip Passed This specifies whether or not program initialization parameters are supported. The value ALLOCATE_PIP_NO provides support for the NO option defined by the LU 6.2 architecture. The TPF system does not support the architecture's YES option. PIP
  security Passed This specifies the security information used to verify the identity of the end users of the conversation. The value ALLOCATE_SECURITY_NO provides support for the NO option defined by the LU 6.2 architecture. This indicates that access security information is omitted on this conversation. The TPF system does not support the architecture's SAME and PGM options. SECURITY
confirm resid Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
  rtsrcvd Returned This specifies where an indication is to be returned that designates whether or not a REQUEST_TO_SEND was received on this conversation. REQUEST_TO_SEND_ RECEIVED
confirmed resid Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
deallocate resid Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
  type Passed This specifies the type of deallocation to be done. TYPE
  logdata Passed This specifies whether or not error information is to be logged. DEALLOCATE_LOGDATA_NO provides support for the NO option defined by the LU 6.2 architecture. The TPF system does not support the architecture's YES option. LOG_DATA
flush resid Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
get_attributes resid Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
  ownname Returned This specifies where the local LU name is returned. OWN_FULLY_ QUALIFIED_LU_NAME
  pluname Returned This specifies where the name of the partner LU is returned. The partner LU name and the fully qualified partner LU name are one and the same. PARTNER_LU_NAME
  mode Returned This specifies where the mode name used for this conversation is returned. MODE_NAME
  sync Returned This specifies where the synchronization level used for this conversation is returned. The values GET_ATTRIBUTES_SYNC_NONE and GET_ATTRIBUTES_SYNC_CONFIRM provide support for the NONE and CONFIRM options defined by the LU 6.2 architecture. The TPF system does not support the architecture's SYNCPT option. SYNCH_LEVEL
get_type resid Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
  type Returned This specifies where the conversation type is returned. TYPE
post_on_ receipt resid Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
  fill Passed This specifies when posting should occur based on the logical record format. The value POST_ON_RECEIPT_FILL_LL provides support for the architecture's LL option. This specifies that posting occurs when a complete or truncated logical record is received, or when a part of a logical record is received that is at least equal in length to that specified on the length parameter. The TPF system does not support the BUFFER option defined by the LU 6.2 architecture. FILL
  length Passed This specifies the minimum amount of data that the LU must receive before the conversation can be posted. This parameter is used along with the fill parameter to determine when to post the conversation. LENGTH
prepare_to_ receive resid Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
  type Passed This specifies the type of PREPARE_TO_RECEIVE to be performed. The values PREP_TO_RECEIVE_TYPE_FLUSH, PREP_TO_RECEIVE_TYPE_CONFIRM, and PREP_TO_RECEIVE_TYPE_SYNC provide support for the architecture's FLUSH, CONFIRM, and SYNC_LEVEL options, respectively. If FLUSH or CONFIRM is specified, the appropriate verb function is performed. If SYNC is specified, the synchronization level specified on the ALLOCATE is used to determine which verb function is to be performed. If the synchronization level was NONE, the FLUSH verb function is performed. If the synchronization level was CONFIRM, the CONFIRM verb function is performed. TYPE
  locks Passed This specifies when control is to be returned, when the CONFIRM verb is used or implied on the type parameter. The value PREP_TO_RECEIVE_LOCKS_SHORT provides support for the SHORT option defined by the LU 6.2 architecture. This causes control to be returned upon the receipt of a positive reply to CONFIRM. The TPF system does not support the architecture's LONG option. LOCKS
receive resid Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
  whatrcv Returned This specifies where the WHAT_RECEIVED indication is returned. The WHAT_RECEIVED indication may indicate data, confirmation, or conversation status. WHAT_RECEIVED
  rtsrcvd Returned This specifies where the REQUEST_TO_SEND indication is to be returned. REQUEST_TO_SEND_ RECEIVED
  fill Passed This specifies when the receive should be satisfied based on the logical record format. The value RECEIVE_FILL_LL provides support for the architecture's LL option. This specifies that posting occurs when a complete or truncated logical record is received, or when a part of a logical record is received that is at least equal in length to that specified on the length parameter. The TPF system does not support the BUFFER option defined by the LU 6.2 architecture. FILL
  wait Passed This specifies that the RECEIVE_AND_WAIT verb function should be performed. The value RECEIVE_WAIT_YES specifies the RECEIVE_AND_WAIT verb. The TPF system does not support the RECEIVE_IMMEDIATE verb defined by the LU 6.2 architecture.  
  data Passed This specifies the location in memory that is to receive the data. DATA
  length Passed and Returned This specifies the maximum length of data that the TP can receive. When control is returned to the TP, this variable contains the actual amount of data the program received up to the maximum. If the program receives information other than data, this variable remains unchanged. LENGTH
request_to_ send resid Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
send_data resid Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
  rtsrcvd Returned This specifies where the REQUEST_TO_SEND indication is to be returned.
  data Passed This specifies the location in memory that contains the data to be sent. DATA
  length Passed This specifies the length of the data to be sent. This data length is in no way related to the length of a logical record. It is used only to determine the length of the data located at the address specified on the DATA parameter. LENGTH
send_error resid Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
  rtsrcvd Returned This specifies where the REQUEST_TO_SEND indication is to be returned. REQUEST_TO_SEND_ RECEIVED
  type Passed This specifies the type of error that was detected. The value SEND_ERROR_TYPE_PROG specifies that the transaction program detected an error. The value SEND_ERROR_TYPE_SVC specifies that the TPF service program detected an error. TYPE
  logdata Passed This specifies whether or not error information is to be logged. The value SEND_ERROR_LOGDATA_NO provides support for the NO option defined by the LU 6.2 architecture. The TPF system does not support the architecture's YES option. LOG_DATA
test resid Passed This specifies the resource ID returned by the ALLOCATE verb or the resource ID assigned by an incoming ATTACH. RESOURCE
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
  test Passed This specifies which condition is to be tested. The value TEST_TEST_POSTED specifies to test whether the conversation was posted. The value TEST_TEST_RTSRCVD specifies to test whether a REQUEST_TO_SEND was received. TEST
wait residl Passed This specifies where a list of resource IDs are located. RESOURCE_LIST
  rcode Returned This specifies where the return code is to be returned. RETURN_CODE
  respstd Returned This specifies where the resource ID of the conversation posted is returned. RESOURCE_POSTED
Note:

Passed
indicates that the value or option is passed from the transaction program to the verb processing component.

Returned
indicates that the value or option is returned to the transaction program from the verb processing component.