List Program Temporary Fixes (QpzListPTF) API

The List Program Temporary Fixes (QpzListPTF) API returns a list of PTFs for the specified product, option, load, and release. The product must be supported or installed before the list of PTFs is returned.

Authorities and Locks

API Public Authority

*EXCLUDE

User Space Authority

*CHANGE

User Space Library Authority

*EXECUTE

User Space Lock

*EXCLRD

Required Parameter Group

Qualified user space name

INPUT; CHAR(20)

The user space that is to receive the generated list. The first 10 characters contain the user space name. The second 10 characters contain the name of the library where the user space is located. You can use these special values for the library name:

*CURLIB

The job's current library

*LIBL

The library list

Product information

INPUT; CHAR(50)

The attributes of the product for which information is being requested. For more information on this parameter, see Format of Product Information.

Format name

INPUT; CHAR(8)

The content and format of the information that is returned for each PTF. The possible format names are:

PTFL0100

List of PTFs for product, option, load, and release.

For more information, see PTFL0100 Format List Section.

Error code

I/O; CHAR(*)

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

Format of Product Information

For the detailed descriptions of each field, see the Field Descriptions

Offset		Type	Field
Dec	Hex
0	0	CHAR(7)	Product ID
7	7	CHAR(6)	Release level
13	D	CHAR(4)	Option
17	11	CHAR(10)	Load ID
27	1B	CHAR(1)	Include superseded PTFs
28	1C	CHAR(22)	Reserved

Field Descriptions

Include superseded PTFs. Whether to include superseded PTFs in the list. Valid values follow:

0

Do not include superseded PTFs in the list.

1

Include superseded PTFs in the list.

Load ID. The load ID for which PTFs are being requested. Load IDs are 10 characters in length. For example, 2924 is the load ID for an English national language version (NLV). You can use the following special value for the load ID:

*ALL

The list of PTFs contains PTFs for all loads for the product specified.

Option. The option number for which PTFs are being requested. Use 0000 for the base option. Valid values are 0000 through 0099, where each character is a digit. You can use this special value for the option:

*ALL

The list of PTFs contains PTFs for all options of the specified product.

Product ID. The product ID for which PTFs are being requested.

Release level. The release of the product for which PTFs are requested.

VxRyMz

The release for which PTFs are being requested. The release must be in the format VxRyMz. Valid entries for x and y are any number between 0 and 9. A valid entry for z is a number between 0 and 9 or a character between A and Z.

You can use this special value for the release:

*ALL

The generated list of PTFs contains PTFs for all releases of the specified product.

Reserved. This field must contain hexadecimal zeros.

Format of the Generated Lists

The user space will contain:

• A user area
• A generic header
• An input parameter section
• A header section
• A list data section:
  • PTFL0100 format

For details about the user area and generic header, see User Space Format for List APIs. For details about the remaining items, see the following sections. For detailed descriptions of the fields in the generated list returned, see Field Descriptions.

When you retrieve the list entry information from a user space, you must use the entry size returned in the generic header. The size of each entry may be padded at the end. If you do not use the entry size, the result may not be valid. For examples of how to process lists, see API examples.

Input Parameter Section

Header Section

PTFL0100 Format List Section

Field Descriptions

Action pending. Indicates whether a required action has yet to be performed to make this PTF active. This field reflects the current status of any required actions.

0

No required actions are pending for this PTF.

1

A required action needs to occur for this PTF to be active. Check the Activation Instructions section of the cover letter to determine what the action is.

If the action required field is 2 and you have performed the activation instructions, then the PTF is active. However, this field will not be updated until the next IPL.

Action required. An action is required to make this PTF active when it is applied. See the cover letter to determine what action needs to be taken. The following values are valid:

0

No activation instructions are needed for this PTF.

1

This PTF was shipped with activation instructions in the cover letter. This value is returned for all PTFs that have an exit program to update the status of the PTF after the activation instructions have been performed.

2

This PTF was shipped with activation instructions in the cover letter. No exit program exists to verify the activation instructions were performed.

Cover letter status. Whether a cover letter exists for the PTF. The following values are valid.

0

The PTF has no cover letter.

1

The PTF has a cover letter.

Format name. The format of the returned information that was requested.

IPL action. The action to be taken on this PTF during the next IPL. The following values are valid:

0

No action occurs at the next IPL.

1

The PTF is temporarily applied at the next IPL.

2

The PTF is temporarily removed at the next IPL.

3

The PTF is permanently applied at the next IPL.

4

The PTF is permanently removed at the next IPL.

IPL required. An IPL is required to apply this PTF. The following values are valid:

0

The PTF is delayed. The PTF must be applied during an IPL.

1

The PTF is immediate. No IPL is needed to apply the PTF.

Blank

The type of the PTF is not known.

Loaded status. The current loaded status of the PTF. A PTF can have any of the following statuses:

0

The PTF has never been loaded.

1

The PTF has been loaded.

2

The PTF has been applied.

3

The PTF has been applied permanently.

4

The PTF has been permanently removed.

5

The PTF is damaged. An error occurred while applying the PTF. It needs to be reloaded and applied.

6

The PTF is superseded. Another PTF with a more recent correction for the problem has been received on the system.

Note: These fields are returned as numbers instead of text because statuses are translatable text instead of special values. The text message that contains these values is CPX3501.

Maximum level. The indicator of the highest level of the product to which this PTF can be applied. The level can be AA to 99. This field will be blank if the product does not have a level.

Minimum level. The indicator or the lowest level of the product to which this PTF can be applied. The level can be AA to 99. This field will be blank if the product does not have a level.

On-order status. Whether the PTF has been ordered. The following values are valid:

0

The PTF has not been ordered or has already been received.

1

The PTF has been ordered.

Product information. The information about the product for which PTFs have been requested. For more information on this field, see Format of Product Information.

Product load of the PTF. The load ID of the product load for the PTF.

Product option of the PTF. The option of the product to which the PTF applies.

PTF ID. The identifier of the PTF.

PTF is released. Whether the PTF save file is available for distribution to another system. This is only set to 1 when the System Manager for AS/400 licensed program is on the system and the product is supported. The user needs to check the PTF save file status before using this field. Possible values follow:

0

The PTF save file cannot be distributed.

1

The PTF save file is released and can be distributed to another system.

Release level of the PTF. The release of the PTF.

Save file status. Whether a save file exists for the PTF. This field should always be checked to determine if a save file exists. The following values are valid.

0

The PTF has no save file.

1

The PTF has a save file.

Status date and time. The date and time that the PTF status was last changed. This value will be blank when the status date and time is not available. The date and time field is in the CYYMMDDHHMMSS format:

C

Century, where 0 indicates years 19xx and 1 indicates years 20xx.

YY

Year

MM

Month

DD

Day

HH

Hour

MM

Minute

SS

Second

User space library name specified. The name specified for the library that contains the user space to receive the generated list.

User space library name used. The actual name of the library that is used to contain the user space that received the list.

User space name specified. The name specified for the user space that is to receive the generated list.

User space name used. The actual name of the user space that received the list.

Error Messages

CPF24B4 E

Severe error while addressing parameter list.

CPF3CF1 E

Error code parameter not valid.

CPF3CF2 E

Error(s) occurred during running of &1 API.

CPF3C1E E

Required parameter &1 omitted.

CPF3C21 E

Format name &1 is not valid.

CPF3C39 E

Value for reserved field not valid.

CPF3C4A E

Value not valid for field &1.

CPF3C90 E

Literal value cannot be changed.

CPF35BE E

Product &1 &3 not supported or installed.

CPF6601 E

No PTF activity exists for product &1.

CPF9801 E

Object &2 in library &3 not found.

CPF9802 E

Not authorized to object &2 in &3.

CPF9803 E

Cannot allocate object &2 in library &3.

CPF9810 E

Library &1 not found.

CPF9820 E

Not authorized to use library &1.

CPF9838 E

User profile storage limit exceeded.

CPF9872 E

Program or service program &1 in library &2 ended. Reason code &3.