Remove Commitment Resource (QTNRMVCR) API

Required Parameter Group:

1	Resource handle	Input	Binary(4)
2	Error code	I/O	Char(*)

Default Public Authority: *USE

Threadsafe: Yes

The Remove Commitment Resource (QTNRMVCR) API removes an API commitment resource that was added to a commitment definition using the Add Commitment Resource (QTNADDCR) API. For more information about adding resources to a commitment definition, see Add Commitment Resource (QTNADDCR) API.

Once a commitment resource is removed, the resource handle that refers to it is no longer valid. You cannot end commitment control for a commitment definition until all API commitment resources have been removed.

If an End Job (ENDJOB) command is entered or you sign off the job, the system automatically ends commitment control for all commitment definitions for the job. Likewise, the system will automatically end an activation-group-level commitment definition for a nondefault activation group that is ending. Any API commitment resources that have not yet been removed from any commitment definition being automatically ended by the system will be implicitly removed by the system during the end job or the activation group end processing. Prior to the system implicitly removing the API commitment resources and automatically ending a commitment definition, an implicit commitment control operation is performed by the system if pending changes exist for the commitment definition, with the appropriate exit program calls made for any API commitment resources. An implicit commit is performed by the system if the activation group is ending normally. An implicit rollback is performed by the system if the activation group is ending abnormally or the job is ending. For more information about the exit program and information that is passed to it, see Commitment Control Exit Program.

Authorities and Locks

None.

Required Parameter Group

Resource handle: INPUT; BINARY(4)
The resource handle returned by the QTNADDCR API when the API commitment resource was added to the commitment definition.
Error code: I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.

Restrictions

You are prevented from removing a commitment resource using this API when:

The resource handle is not valid.
Commitment control is not active for the program making the request to remove the commitment resource.
A commitment control operation is currently in progress for the commitment definition that is to have the commitment resource removed from the commitment definition.

In all other instances, the API commitment resource is removed from the commitment definition.

Error Messages

Message ID	Error Message Text
CPF24B4 E	Severe error while addressing parameter list.
CPF3C90 E	Literal value cannot be changed.
CPF3CF1 E	Error code parameter not valid.
CPF8362 E	Request for commit resource is not valid; reason code &1.
CPF8367 E	Cannot perform commitment control operation.
CPF9872 E	Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V3R1

[ Back to top | Journal and Commit APIs | APIs by category ]