FREE
Finishes with an advanced program-to-program communications (APPC) conversation. (An APPC conversation allows a program to send data to, and receive data from, a program that is running in a remote system. Programming that uses APPC conversations is called Distributed Transaction Programming (DTP). For guidance information about DTP, see Distributed transaction processing (DTP).)
Syntax
Description
FREE finishes with the APPC conversation that is named in the CONVID option.
If you omit CONVID, the principal facility is freed. Facilities that are not freed explicitly are freed by CICS® when the task terminates.
If you are running EDF and the transaction issues a FREE command, EDF is switched off without warning.
Options
- CONVID(name)
- Identifies
the conversation on the APPC session to be freed. The four-byte name identifies
either the token that was returned by a previously executed ALLOCATE command
in the EIBRSRCE field of the EIB, or the token that represents the principal
facility (returned by a previously executed ASSIGN command).
If this option is omitted, the principal facility is assumed.
- STATE(cvda)
- Gets
the state of the current conversation.
If the FREE command is successful, a STATE value of zero is returned. See STATE.
Conditions
- INVREQ
- Occurs
for the following conditions, depending on the options that are specified
on the FREE command:
- FREE is not valid for the current state of the APPC conversation.
- The CONVID option is omitted and the principal facility is not an APPC conversation.
- An attempt was made to use a distributed transaction processing (DTP) command on a valid non-DTP CONVID.
- A remotely linked-to program attempted to execute a FREE CONVID command that refers to the principal facility.
Default action: Terminates the task abnormally.
- NOTALLOC
- Occurs if the specified CONVID value does not relate to a conversation that is owned by the application.