ATBGETP - Get_TP_Properties (For MVS/ESA 4.2 through OS/390 V1R2)

Note: You cannot use the Error_Extract conversation service to diagnose errors in calls to the Get_TP_Properties service.

Equivalent to:

LU 6.2 Get_TP_Properties
(No CPI equivalent)

Returns information pertaining to the transaction program issuing the call.

This section describes the Get_TP_Properties (ATBGETP) callable service provided with MVS/ESA Version 4 Release 2. The Get_TP_Properties service was enhanced for OS/390 Release 8, and renamed ATBGTP4 (see Get_TP_Properties). The ATBGETP call remains valid, but does not contain the enhancements included in ATBGTP4.

Requirements

Authorization:

Supervisor state or problem state, any PSW key

Dispatchable unit mode:

Task or SRB mode

Cross memory mode:

Any PASN, any HASN, any SASN

AMODE:

31-bit

ASC mode:

Primary or access register (AR)

Interrupt status:

Enabled for I/O and external interrupts

Locks:

Unlocked

Control parameters:

All parameters must be addressable by the caller and in the primary address space.

Format

Figure 1. ATBGETP - LU 6.2 Get_TP_Properties

CALL ATBGETP(
        Own_TP_name_length,
        Own_TP_name,
        Own_fully_qualified_LU_name,
        User_id,
        Profile,
        LUW_id,
        Return_code
       );

Parameters

Own_TP_name_length

Returned parameter

Type: Integer
Char Set: N/A
Length: 32 bits

Own_TP_name_length specifies the length of data contained in the Own_TP_name parameter. If the Own_TP_name parameter does not contain a TP_name on return from this service, Own_TP_name_length is set to zero.

Own_TP_name

Returned parameter

Type: Character string
Char Set: 00640 or Type A
Length: 64 bytes

Own_TP_name specifies the name of the local program as specified in the FMH-5 allocation request. This parameter will only contain a return value if the local program was started as the result of an attach request from a partner program. If this is not the case, there is no TP name to be returned, and Own_TP_Name_Length is set to zero.

Own_fully_qualified_LU_name

Returned parameter

Type: Character string
Char Set: Type A
Length: 17 bytes

Own_fully_qualified_LU_name specifies the network-qualified name of the local logical unit.

User_id

Returned parameter

Type: Character string
Char Set: No restriction
Length: 10 bytes

User_id specifies the user ID that is associated with the caller's address space. If the address space contains a scheduled transaction program, the User_id parameter contains the user ID that accompanied the inbound transaction program request.

Profile

Returned parameter

Type: Character string
Char Set: No restriction
Length: 10 bytes

Profile specifies the RACF group name associated with the caller's address space. If the address space contains a scheduled transaction program, the profile parameter contains the RACF group name that accompanied the inbound transaction program request. If the inbound request did not include a profile, the profile parameter contains the default profile for the transaction program that issued the request.

LUW_id

Returned parameter

Type: Structure
Char Set: N/A
Length: 26 bytes

LUW_id specifies the logical unit of work (LUW) identifier. The LUW identifier is used by some logical units for accounting purposes. If no LUW identifier is present, this field will contain binary zeroes.

Return_code

Returned parameter

Type: Integer
Char Set: N/A
Length: 32 bits

Return_code specifies the return code that is returned to the local program. In cases where an error code is returned, the program should not examine any other returned variable associated with the call as nothing is placed in the variables.

See Return Codes for descriptions of return codes that can be returned to a caller of Get_TP_Properties.

Return Codes

Valid return code values for the Return_code parameter are:

Table 1. Return Codes for the Get_TP_Properties Service
Return Code	Value, Meaning, and Action
0	Value: OK Meaning: The call completed successfully. System Action: The system continues processing. Application Programmer Response: None required.
20	Value: Product_specific_error Meaning: The system found a product-specific error. System Action: The system might write symptom records, which describe the error, to the logrec data set. Application Programmer Response: See Diagnosing Product-Specific Errors for more information about product-specific errors.
25	Value: Program_state_check Meaning: The program called a service under conditions in which the call is not valid; for example: APPC/MVS might not recognize the program as a local TP. APPC/MVS might have encountered temporary environmental conditions that prevent it from obtaining the requested information. The program should not examine any other returned variables associated with the call because nothing is placed in those variables. System Action: The state of the conversation remains unchanged. Application Programmer Response: Design the program to re-issue the call; this error condition might be temporary.

Restrictions

Transaction programs that call the Get_TP_Properties service while in task mode should not have any enabled unlocked task (EUT) functional recovery routines (FRRs) established. For more information about EUT FRRs, see the section on providing recovery in z/OS MVS Programming: Authorized Assembler Services Guide.