Delete PTF Group (QpzDeletePtfGroup) API


  Required Parameter Group:

1 PTF group name Input CHAR(60)
2 PTF group level Input BINARY(4)
3 Delete related PTF groups Input CHAR(1)
4 CCSID Input BINARY(4)
5 Error code I/O CHAR(*)

  Service Program Name: QPZGROUP

  Default Public Authority: *USE

  Threadsafe: No

The Delete PTF Group (QpzDeletePtfGroup) API deletes a PTF group from the system. You can optionally delete all related PTF groups at the same time.


Authorities and Locks

Work with PTF Groups (WRKPTFGRP) command
*USE

Lock conflicts may occur if this API is called while another PTF or PTF group operation is in progress.


Required Parameter Group

PTF group name
INPUT; CHAR(60)

The name or generic name of the PTF group to be deleted. A generic name is a string of one or more characters followed by an asterisk (*). You can use these special values for the PTF group name:

*ALL All PTF groups on the system are deleted.

PTF group level
INPUT; BINARY(4)

The level of the PTF group to be deleted. This parameter defaults to all levels when a generic name or *ALL is specified for the PTF group name. Valid values for this parameter are:

0 The highest level of the PTF group is deleted.
1 - 99999 The specified level of the PTF group is deleted. If the level does not exist on the system, an error will occur.
-1 All levels of the PTF group are deleted.

Delete related PTF groups
INPUT; CHAR(1)

Whether related PTF groups will be deleted at the time this PTF group is deleted. This parameter defaults to 0 when a generic name or *ALL is specified for the PTF group name. Valid values for this parameter are:

0 Related PTF groups will not be deleted.
1 The highest level of the related PTF groups will be deleted when this PTF group is deleted. This will also delete the highest level of all related PTF groups of the related PTF groups.
2 All levels of the related PTF groups will be deleted when this PTF group is deleted. This will also delete all levels of the related PTF groups of the related PTF groups.

CCSID
INPUT; BINARY(4)

The coded character set ID for the PTF group name. Valid values are 0 through 65533. If a value of 0 is specified, the name is assumed to be in the CCSID of the job.

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.


Error Messages

Message ID Error Message Text
CPF0CEE E Unable to convert data to CCSID &1.
CPF36A2 E Length of PTF group name or text too long.
CPF36A4 E PTF group &1 not found.
CPF36A6 E PTF group name &1 not valid.
CPF36AF E PTF group function already in progress.
CPF3BC7 E CCSID &1 outside of valid range.
CPF3C3C E Value for parameter &1 not valid.
CPF3CF1 E Error code parameter not valid.
CPF3CF2 E Error(s) occurred during running of &1 API.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.


API introduced: V5R2

[ Back to top | Software Product APIs | APIs by category ]