Functions provided by the partner resource manager

Table 83 summarizes the external subroutine interfaces provided by the partner resource manager. It shows the subroutine call formats, the level-1 trace point IDs of the modules providing the functions for these formats, and the functions provided.

Table 83. Partner resource manager’s subroutine interfaces
Format Trace Function
PRCM
AP 0F36
AP 0F37
INQUIRE_PARTNER
START_PARTNER_BROWSE
GET_NEXT_PARTNER
END_PARTNER_BROWSE
PRFS
AP 0F34
AP 0F35
LOCATE_AND_LOCK_PARTNER
PRIN
AP 0F20
AP 0F21
START_INIT
COMPLETE_INIT
PRPT
AP 0F30
AP 0F31
ADD_REPLACE_PARTNER
DELETE_PARTNER

PRCM format, INQUIRE_PARTNER function

The INQUIRE_PARTNER function of the PRCM format is used to retrieve the installed definition of a specified partner, consisting of the remote transaction program name (TP name), network identifier, netname (network LU name), and profile name.

Input parameters

PARTNER_NAME
is the 8-character name of the entry whose contents are to be retrieved.
TP_NAME
is a buffer for the output TP name.

Output parameters

NETWORK
is the 8-character network identifier.
NETNAME
is the 8-character netname.
PROFILE_NAME
is the 8-character CICS® profile name.
RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|EXCEPTION|KERNERROR
[REASON]
is returned when RESPONSE is EXCEPTION. It has this value:
PARTNER_NOT_FOUND

PRCM format, START_PARTNER_BROWSE function

The START_PARTNER_BROWSE function of the PRCM format is used to initiate a browse of the partner resource table. The browse starts at the beginning of the table.

Input parameters

None.

Output parameters

BROWSE_TOKEN
is the token identifying the browse session initiated by this call.
RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER. It has this value:
GETMAIN_FAILED

PRCM format, GET_NEXT_PARTNER function

The GET_NEXT_PARTNER function of the PRCM format is used to retrieve the information stored in the next partner found in a sequential browse of the partner resource table.

Input parameters

BROWSE_TOKEN
is the token identifying this browse session.
TP_NAME
is a buffer for the output TP name.

Output parameters

PARTNER_NAME
is the 8-character name of the entry retrieved.
NETWORK
is the 8-character network identifier.
NETNAME
is the 8-character netname.
PROFILE_NAME
is the 8-character CICS profile name.
RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|EXCEPTION|KERNERROR
[REASON]
is returned when RESPONSE is EXCEPTION. It has this value:
END_OF_LIST

PRCM format, END_PARTNER_BROWSE function

The END_PARTNER_BROWSE function of the PRCM format is used to terminate a browse of the partner resource table.

Input parameters

BROWSE_TOKEN
is the token identifying this browse session.

Output parameters

RESPONSE
is the subroutine’s response to the call. It can have either of these values:
OK|KERNERROR

PRFS format, LOCATE_AND_LOCK_PARTNER function

The LOCATE_AND_LOCK_PARTNER function of the PRFS format is used to retrieve the information stored in a named entry in the partner resource table. A table manager read lock is applied to the entry.

Input parameters

PARTNER_NAME
is the 8-character name of the entry whose contents are to be retrieved.
TP_NAME
is a buffer for the output TP name.

Output parameters

NETWORK
is the 8-character network identifier.
NETNAME
is the 8-character netname.
PROFILE_NAME
is the 8-character CICS profile name.
RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|EXCEPTION|KERNERROR
[REASON]
is returned when RESPONSE is EXCEPTION. It has this value:
PARTNER_NOT_FOUND

PRIN format, START_INIT function

The START_INIT function of the PRIN format is used to attach a CICS task to perform initialization of the partner resource manager.

Input parameters

None.

Output parameters

RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|DISASTER|KERNERROR
[REASON]
is returned when RESPONSE is DISASTER. It can have either of these values:
RESPONSE Possible REASON values
DISASTER
GETMAIN-FAILED
ADD_SUSPEND_FAILED

PRIN format, COMPLETE_INIT function

The COMPLETE_INIT function of the PRIN format is used to wait for the initialization task attached by the START_INIT function to complete processing.

Input parameters

None.

Output parameters

RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|DISASTER|KERNERROR
[REASON]
is returned when RESPONSE is DISASTER. It has this value:
INIT_TASK_FAILED

PRPT format, ADD_REPLACE_PARTNER function

The ADD_REPLACE_PARTNER function of PRPT format is used to add a named entry to the partner resource table. The new entry replaces the existing entry (if any) with the specified name.

Input parameters

PARTNER_NAME
is the 8-character name of the entry whose contents are to be added or replaced.
NETWORK
is the 8-character network identifier.
NETNAME
is the 8-character netname.
PROFILE_NAME
is the 8-character CICS profile name.
TP_NAME
specifies the address and length of a buffer containing the TP name.
SYSTEM_STATUS
specifies the status of the CICS system at the time of the call. It can have any one of these values (ONLINE here means during execution):
COLD_START|WARM_START|ONLINE

Output parameters

RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER
CATALOG_WRITE_FAILED
GETMAIN_FAILED
EXCEPTION PARTNER_IN_USE

PRPT format, DELETE_PARTNER function

The DELETE_PARTNER function of the PRPT format is used to delete a named entry in the partner resource table.

Input parameters

PARTNER_NAME
is the 8-character name of the entry to be deleted.
SYSTEM_STATUS
is the status of the CICS system at the time of the call. It can have any one of these values (ONLINE here means during execution):
COLD_START|WARM_START|ONLINE

Output parameters

RESPONSE
is the subroutine’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|KERNERROR
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER CATALOG_DELETE_FAILED
EXCEPTION
PARTNER_IN_USE
PARTNER_NOT_FOUND
[[ Contents Previous Page | Next Page Index ]]