|
Required Parameter Group:
|
The Retrieve Program Temporary Fix Information (QPZRTVFX) API returns information about a specific program temporary fix (PTF). The information returned is determined by the format specified.
You can use the QPZRTVFX API to:
Lock conflicts may occur if this API is called while another PTF operation is in progress.
The receiver variable that is to receive the information requested. The length of this area must be passed in the length of receiver variable parameter. The API returns only the data the area can hold.
The length of the receiver variable. You can specify a smaller area than the format requested as long as you specify the length of receiver variable parameter correctly. If the length specified is larger than the size of the receiver variable, the results are not predictable. This value must be greater than or equal to 8.
The attributes of the PTF for which information is being requested. For more information on this parameter see Format of PTF Information.
The content and format of the information returned for the PTF. The possible format names are:
The structure in which to return error information. For the format of the structure, see Error Code Parameter.
For detailed descriptions of each field, see the Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(7) | PTF ID |
| 7 | 7 | CHAR(7) | Product ID |
| 14 | E | CHAR(6) | Release level |
| 20 | 14 | BINARY(4) | CCSID for returned directory names |
| 24 | 18 | CHAR(1) | Close PTF database files |
| 25 | 19 | CHAR(25) | Reserved |
CCSID for returned directory names. The CCSID in which the directory names should be returned. If this field is blank, the CCSID is the job default CCSID. This value is used only for returned directory names.
Close PTF database files. Whether the PTF database files should remain open after returning from the API call. This field allows for improved performance when this API is called numerous times during processing. Do not leave the PTF database files open for long periods of time because other PTF operations cannot be performed while these files are open. If a blank is specified in this field, it will be treated as a 0.
Product ID. The product ID for the PTF for which information is requested. The possible values are:
PTF ID. The identifier of the PTF for which information is requested.
Release level. The release of the PTF for which information is requested. This field is ignored if *ONLY is specified in the product ID field. The format is:
Reserved. This field must contain blanks.
This format returns basic information about the PTF.
For detailed descriptions of each field, see the Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Offset to additional information |
| 12 | C | CHAR(7) | Product ID |
| 19 | 13 | CHAR(7) | PTF ID |
| 26 | 1A | CHAR(6) | Release level |
| 32 | 20 | CHAR(4) | Product option |
| 36 | 24 | CHAR(4) | Load ID |
| 40 | 28 | CHAR(1) | Loaded status |
| 41 | 29 | CHAR(1) | Cover letter status |
| 42 | 2A | CHAR(1) | On-order status |
| 43 | 2B | CHAR(1) | Save file status |
| 44 | 2C | CHAR(10) | File name |
| 54 | 36 | CHAR(10) | File library name |
| 64 | 40 | CHAR(1) | PTF type |
| 65 | 41 | CHAR(1) | IPL action |
| 66 | 42 | CHAR(1) | Action pending |
| 67 | 43 | CHAR(1) | Action required |
| 68 | 44 | CHAR(1) | PTF is released |
| 69 | 45 | CHAR(6) | OS/400 target release |
| 75 | 4B | CHAR(7) | Superseding PTF |
| 82 | 52 | CHAR(1) | Current IPL source |
| 83 | 53 | CHAR(2) | Minimum level |
| 85 | 55 | CHAR(2) | Maximum level |
| 87 | 57 | CHAR(1) | Format information available |
| 88 | 58 | CHAR(13) | Status date and time |
| 101 | 65 | CHAR(7) | Licensed Internal Code group |
| 108 | 6C | CHAR(*) | Reserved |
The fields that follow the
cover letter records field define an entry in that array.
That group of fields is repeated by the number of different
NLVs available for the cover letter field.
For detailed descriptions of each field, see the Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 |
| All information from format PTFR0100 |
| Note: The decimal and hexadecimal offsets are reached by using the offset to additional information field in format PTFR0100. | |||
|
| BINARY(4) | Offset to first cover letter record from the beginning | |
| BINARY(4) | Number of different NLVs available for the cover letter | ||
| BINARY(4) | Length of cover letter record | ||
| CHAR(*) | Reserved | ||
| Note: The decimal and hexadecimal offsets are determined by using the value in the offset to first cover letter of format PTFR0200. | |||
|
| ARRAY of CHAR(*) | Cover letter records | |
| CHAR(4) | Cover letter national language version (NLV) | ||
| CHAR(10) | Cover letter file name | ||
| CHAR(10) | Cover letter library name | ||
| CHAR(10) | Cover letter member name | ||
| CHAR(*) | Reserved | ||
The fields following the requisite record field define an
entry in that array.
That group of fields is repeated by the number of requisites.
For detailed descriptions of each field, see the Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 |
| All information from format PTFR0100 |
| Note: The decimal and hexadecimal offsets are reached by using the offset to additional information field in format PTFR0100. | |||
|
| BINARY(4) | Offset to first requisite record | |
| BINARY(4) | Number of requisites | ||
| BINARY(4) | Length of requisite record | ||
| CHAR(*) | Reserved | ||
| Note: The decimal and hexadecimal offsets are determined by using the value in the offset to first requisite record of format PTFR0300. | |||
|
| ARRAY of CHAR(*) | Requisite record | |
| CHAR(7) | Requisite product ID | ||
| CHAR(7) | Requisite PTF ID | ||
| CHAR(6) | Release of requisite | ||
| CHAR(2) | Requisite minimum level | ||
| CHAR(2) | Requisite maximum level | ||
| CHAR(1) | Type of requisite | ||
| CHAR(1) | Requisite is conditional | ||
| CHAR(1) | Requisite is required | ||
| CHAR(4) | Requisite option | ||
| CHAR(4) | Requisite load ID | ||
| CHAR(*) | Reserved | ||
The fields following the PTF object record field define an
entry in that array. That group of fields is repeated by the
number of PTF objects. If a PTF contains subobjects, an offset to
an array of subobjects is provided. The subobject fields are
repeated by the number of PTF subobjects. For detailed
descriptions of each field, see the Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 |
| All information from format PTFR0100 |
| Note: The decimal and hexadecimal offsets are reached by using the offset to additional information field in format PTFR0100. | |||
|
| BINARY(4) | Offset to the first PTF object record | |
| BINARY(4) | Number of PTF objects | ||
| BINARY(4) | Length of PTF object record | ||
| BINARY(4) | CCSID of returned directories | ||
| CHAR(1) | Error indicator for CCSID conversion | ||
| CHAR(*) | Reserved | ||
| Note: The decimal and hexadecimal offsets are determined by using the value in the offset to the first PTF object record of format PTFR0400. | |||
|
| ARRAY of CHAR(*) | PTF object record | |
| BINARY(4) | Offset to this PTF object's first subobject record | ||
| BINARY(4) | Number of PTF subobjects | ||
| BINARY(4) | Length of subobject record | ||
| CHAR(10) | Object name | ||
| CHAR(10) | Object library | ||
| CHAR(10) | Alternative object name | ||
| CHAR(7) | Object type | ||
| CHAR(*) | Reserved | ||
| Note: The decimal and hexadecimal offsets are determined by using the value in the offset to this PTF object's first subobject record of format PTFR0400. | |||
|
| ARRAY of CHAR(*) | PTF subobject record | |
| BINARY(4) | Offset to subobject name | ||
| BINARY(4) | Length of subobject name | ||
| CHAR(7) | Subobject attribute | ||
| CHAR(*) | Reserved | ||
| Note: The decimal and hexadecimal offsets are determined by using the value in the offset to the subobject name in the subobject array record of format PTFR0400. | |||
|
|
| CHAR(*) | Subobject name |
The fields following the dependent record field define an
entry in that array.
That group of fields is repeated by the number of dependents.
For detailed descriptions of each field, see the Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 |
| All information from format PTFR0100 |
| Note: The decimal and hexadecimal offsets are reached by using the offset to additional information field in format PTFR0100. | |||
|
| BINARY(4) | Offset to first dependent PTF record | |
| BINARY(4) | Number of dependent PTFs | ||
| BINARY(4) | Length of dependent PTF record | ||
| CHAR(*) | Reserved | ||
| Note: The decimal and hexadecimal offsets are determined by using the value in the offset to first dependent PTF record of format PTFR0500. | |||
|
| ARRAY of CHAR(*) | Dependent PTF record | |
| CHAR(7) | Dependent product ID | ||
| CHAR(7) | Dependent PTF ID | ||
| CHAR(6) | Release of dependent PTF | ||
| CHAR(2) | Dependent minimum level | ||
| CHAR(2) | Dependent maximum level | ||
| CHAR(1) | Type of dependent PTF | ||
| CHAR(4) | Dependent option | ||
| CHAR(4) | Dependent load ID | ||
| CHAR(*) | Reserved | ||
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. The following values are valid:
Check the activation instructions section of the cover letter to determine what the action is.
If the action required field is a 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. Indicates whether 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.
Alternative object name. The alternative name of the object when the PTF is temporarily applied or temporarily removed. PTFs that have been temporarily applied have alternative object names in the format of QPZAnnnnnn; PTFs that are temporarily removed have alternative object names in the format of QPZRnnnnnn, where nnnnnn is some number. This field is blank for the following reasons:
the PTF is not temporarily applied or is temporarily removed.
the object is a temporary object on the system; that is, an object name that starts with QPZ1 or QPZ2.
the object was bypassed when the PTF was loaded.
Bytes available. The number of bytes of data available to be returned to the user.
Bytes returned. The number of bytes that were returned to the user. This is the lesser of the number of bytes available to be returned or the length of the receiver variable.
CCSID of returned directories. The value of the CCSID in which the directories were returned. This will be the requested CCSID if the value of the CCSID conversion indicator is 0. This field is used only for subobject attributes of DIR (directory) and SOM (system object model).
Cover letter file name. The file containing the cover letter member.
Cover letter library name. The library containing the cover letter file.
Cover letter member name. The member containing the cover letter.
Cover letter national language version (NLV). The NLV corresponds to a code that indicates what language the cover letter was written in. For more information on NLVs, see the National Language Support book.
Cover letter records. The record containing the cover letter information.
Cover letter status. Whether a cover letter exists for the PTF. The following values are valid.
Current IPL source. The copy of Licensed Internal Code that the system is currently operating from. The previous IPL of the system used this copy of Licensed Internal Code.
Dependent load ID. The load ID of the dependent PTF. This value is blank when the load ID of the dependent PTF cannot be determined.
Dependent maximum level. The indicator of the highest level of the product for which this PTF can be installed. This field will be blank if the product has no level.
Dependent minimum level. The indicator of the lowest level of the product for which this PTF can be installed. This field will be blank if the product has no level.
Dependent option. The product option of the dependent PTF. This value is blank when the option of the dependent PTF cannot be determined.
Dependent product ID. The product ID of the dependent PTF.
Dependent PTF ID. The PTF ID of the dependent PTF.
Dependent PTF record. The information about the dependent PTF. The record is an array that contains the fields in format PTFR0500.
Error indicator about CCSID conversion. Whether the CCSID conversion to the requested CCSID was successful. If the requested CCSID conversion fails, the CCSID in which the directories are returned is identified in the CCSID of returned directories field. This field is used only for subobject attributes of DIR (directory) and SOM (system object model). Possible values follow:
File library name. The name of the library where the save file for the PTF is located. If no save file name has been reserved, this field will be blank.
File name. The name of the file where the save file for the PTF is located. If no save file name has been reserved, this field will be blank.
Format information available. When you request information using formats PTFR0300 or PTFR0400, this field indicates whether the system has the information available to return for the PTF. The system may not be able to return the requested information if the PTF is permanently applied or superseded and does not have a save file. The possible values are:
IPL action. The action to be taken on this PTF during the next IPL. The following values are valid:
Length of cover letter record. The length of each cover letter record.
Length of dependent PTF record. The length of each dependent PTF record.
Length of PTF object record. The length of one array element in the PTF object record.
Length of requisite record. The length of each requisite record.
Length of subobject name. The length of the subobject name.
Length of subobject record. The length of one array element in the subobject record.
Licensed Internal Code Group. The name of the Licensed Internal Code Group for this PTF. If the name of the group is not available or if the PTF is not a Licensed Internal Code fix, this field will be blank.
Loaded status. The current loaded status of the PTF. A PTF can have any of the following statuses:
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.
This field may be blank.
Load ID. The load ID of the product load for the PTF.
Maximum level. The indicator of the highest level of the product on which this PTF can be installed. If the minimum and maximum levels are the same, then this PTF can only be installed on one level of the product. The level can be AA to 99. This field will be blank if the product has no level.
Minimum level. The indicator of the lowest level of the product on which this PTF can be installed. If the minimum and maximum levels are the same, then this PTF can only be installed on one level of the product. The level can be AA to 99. This field will be blank if the product has no level.
Number of dependent PTFs. The number of dependent PTFs available. The receiver variable may not have been large enough to hold all the dependent PTF records. If so, the number of dependents returned may be less than this value.
Number of different NLVs available for the cover letter. Cover letter member names are returned in an array. This number indicates how many NLVs were available for the cover letter. However, the length of the receiver may not have been large enough to hold all the cover letter NLVs available. If so, the number of cover letter member names returned may be less than this value.
Number of requisites. The number of requisite PTFs available. The receiver variable may not have been large enough to hold all the requisite PTF records. If so, the number of requisites returned may be less than this value.
Check the format information available field returned in PTFR0100 before using this value. The number of requisites will be zero when the system cannot determine if this PTF has requisite PTFs.
Number of PTF objects. The number of PTF objects available. The receiver variable may not have been large enough to hold all the PTF object records. If so, the number of PTF objects returned may be less than this value.
Check the format information available field returned in PTFR0100 before using this value. The number of objects will be zero when the system cannot determine the number of objects contained in this PTF.
Number of PTF subobjects. The number of PTF subobjects associated with this PTF object. The receiver variable may not have been large enough to hold all the PTF subobject records. If so, the number of PTF subobjects returned may be less than this value.
Object library. The primary library where PTF objects will be placed for this product. If the product was installed in the primary library, this is the library where the PTF objects will reside.
Note: If the product was installed in a library other than the primary library, the API user might need to determine the installed library that corresponds to this primary library by using format PRDR0200 of the Retrieve Product Information (QSZRTVPR) API.
Object name. The name of the object that is contained in the PTF.
Object type. The symbolic type of the object that is contained in the PTF.
Offset to additional information. The offset from the beginning of the receiver variable to the start of either the cover letter information or the requisite information. This is to allow expansion of the basic information.
Offset to first cover letter record from the beginning. The offset from the beginning of the receiver variable to the first cover letter record.
Offset to first dependent PTF record. The offset from the beginning of the receiver variable to the start of the first dependent PTF record.
Offset to first requisite record. The offset from the beginning of the receiver variable to the start of the first requisite record.
Offset to the first PTF object record. The offset from the beginning of the receiver variable to the start of the PTF object record.
Offset to this PTF object's first subobject record. The offset from the beginning of the receiver variable to the start of the first PTF subobject record.
Offset to subobject name. The offset from the beginning of the receiver variable to the start of the subobject name.
On-order status. Whether the PTF has been ordered. The following values are valid:
OS/400 target release. The earliest release of the operating system on which you can load and apply the PTF. The release level is specified in the format VxRyMz, where Vx is the version, Ry is the release, Mz is the modification level.
Product ID. The PTF is for this product. The product must be installed or supported.
Product option. The PTF is for this option of the product.
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 are:
PTF object record. The information about the PTF objects. The record is an array that contains the fields described in format PTFR0400.
This information is only available if the PTF is loaded, temporarily applied, or has a save file.
PTF subobject record. The information about the PTF subobjects. The record is an array that contains the fields described in format PTFR0400.
PTF type. The type of PTF. The possible values are:
Release level. The release of the PTF. It must be in the format of VxRyMz. Valid entries for x and y are any number between 0 and 9. Valid entries for z is any number between 0 and 9 or a character between A and Z.
Release of dependent PTF. The release of the dependent PTF.
Release of requisite. The release of the requisite PTF.
Requisite is conditional. Whether the requisite relationship is conditional. Users should check this field to determine whether it is necessary to check a remote system for the presence of the software that is described in the product ID, release, option, and load ID.
Requisite is required. Whether a requisite PTF is required on this system. The possible values are:
Requisite load ID. The load ID of the requisite PTF. This value may be blank when the load ID of the requisite PTF cannot be determined.
Requisite option. The product option of the requisite PTF. This value may be blank when the option of the requisite cannot be determined.
Requisite maximum level. The indicator of the highest level of the product on which this PTF can be installed. This field will be blank if the product has no level.
Requisite minimum level. The indicator of the lowest level of the product on which this PTF can be installed. This field will be blank if the product has no level.
Requisite product ID. The product ID of the requisite PTF.
Requisite PTF ID. The PTF ID of the requisite PTF.
Requisite record. The information about the requisite. The record is an array that contains the fields in format PTFR0300.
Reserved. This field is ignored.
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.
Status date and time. The date and time the PTF status was last changed. This field will be blank when the status date and time is not available. The date and time field is in the CYYMMDDHHMMSS format:
Subobject attribute. The type of subobject contained in the PTF. The possible values follow:
Subobject name. The name of the subobject. This is a name of an object that is not limited to 10 characters.
Superseding PTF. The PTF ID of the PTF that supersedes this PTF. This field may be blank if the PTF is not superseded or if the superseding PTF is not known.
Type of dependent PTF. The type of dependent relationship. The possible values are:
Type of requisite. The type of requisite relationship. The possible values are:
|
Top
| Software Product APIs
Software Product API list | APIs by category |
| [ Information Center Home Page ] | [ Legal | AS/400 Glossary ] |