| 1 | Number of entries removed | Output | Binary(4) |
| 2 | Entries removed | Output | Char(*) |
| 3 | Length of entries removed | Input | Binary(4) |
| 4 | Entry lengths and entry offsets | Output | Array(*) of Char(8) |
| 5 | Length of entry lengths and offsets | Input | Binary(4) |
| 6 | Qualified PDF Map object name | Input | Char(20) |
| 7 | Maximum number of entries | Input | Binary(4) |
| 8 | Remove criteria | Input | Char(*) |
| 9 | Error code | I/O | Char(*) |
The Remove PDF Map object Entries (QPQRPME) API removes one or more PDF Map object entries that match the values specified on the remove criteria parameter. It returns the number of entries that were removed and, optionally, returns the actual PDF map entries removed.
The number of PDF map entries, satisfying the values specified on the remove criteria parameter, that were successfully removed from the PDF Map object. If this field is 0, no entries satisfied the remove criteria. This value can never be greater than the maximum number of entries parameter.
The actual entries removed. All entries that satisfied the remove criteria parameter and were removed (up to the maximum number of entries parameter) are returned if sufficient space is provided. The API returns only the data that the area can hold.
If you do not want the entries that were removed to be returned in this parameter, specify 0 for the length of entries removed parameter.
Every entry removed causes the number of entries removed parameter to be incremented by 1.
The format of this parameter is the same as the Remove criteria parameter. Refer to Remove criteria Format for the layout of this parameter.
The length of the entries removed parameter. If this length is larger than the actual size of the entries removed parameter, the results may not be predictable. The minimum length is 0 or >= (greater than or equal to) 8 bytes. If 0 is used, the entries removed from the PDF Map are not returned and the bytes returned and the bytes available in the entries removed parameter are not set.
A data structure that contains entry lengths and entry offsets for all entries that were found that met the remove criteria parameter. An entry length and entry offset exist for every entry returned in the entries removed parameter. These entry lengths and entry offsets are used to parse through the entries removed parameter. If the length of entries removed parameter is 0, this information will not be returned.
The size of the entry lengths and entry offsets parameter should be at least:
8 + (the maximum number of entries parameter * 8)
You must provide enough space in both the entries removed and the entry lengths and offset parameter for this API to return complete information to you.
See Format for Entry Lengths and Entry Offsets for details on the data structure.
The length of the entry lengths and entry offsets. If the length is longer than the entry lengths and entry offsets parameter, the results may not be predictable. The minimum length is 8. If the length of entries removed parameter is 0, which means you do not want the entries removed to be returned, this parameter is ignored.
The PDF Map object from which you want to remove entries, and the library in which it is located. The first 10 characters contain the PDF Map object name, and the second 10 characters contain the library name.
You can use these special values for the library name:
| *CURLIB | The job's current library |
| *LIBL | The library list |
The maximum number of PDF Map object entries to be removed that satisfy the remove criteria. Valid values are 1 through 4095.
The criteria used to find matches in the PDF Map object.
Refer to Remove criteria Format for details on the format.
The structure in which to return error information. For the format of the structure, see Error Code Parameter.
The following information is returned in the entry lengths and entry offsets parameter. This information is needed to parse through the entries removed parameter. For detailed descriptions of the fields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| Note: The following fields will be repeated. The number of times they are repeated depends on the length of the entry lengths and entry offsets parameter and the number of entries actually removed. | |||
| BINARY(4) | Entry offset | ||
| BINARY(4) | Entry length | ||
The following information is the format of the remove criteria. The same format is also used for what is returned in the Entries removed parameter. For more details about the fields in the following table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Sequence number |
| 14 | E | CHAR(10) | Output queue name |
| 24 | 18 | CHAR(10) | Output queue library name |
| 34 | 22 | CHAR(10) | Spooled file name |
| 44 | 2C | CHAR(10) | Job name |
| 54 | 36 | CHAR(10) | User name |
| 64 | 40 | CHAR(10) | User data |
| 74 | 4A | CHAR(10) | Form type |
| 84 | 54 | CHAR(250) | Mail tag |
Bytes available. The length of all data available to return. All available data is returned if enough space is provided.
Bytes returned. The length of the data actually returned.
Entry length. The length of the entry removed from the PDF Map object. Valid values are 1-2000, depending on how the PDF Map object was created.
Entry offset. The number of bytes from the beginning of the immediately preceding entry to the first byte of the entry returned. For the first entry, the offset is the number of bytes from the beginning of the parameter to the first byte of the first entry.
Form type. The type of forms that should be loaded on the printer before this spooled file is printed or spooled files whose form type matches this value are included in the list. This field can be used in conjunction with any of the other values in the Remove criteria format to select a list of entries to remove.
The following special values can be used for the form type:
| *ALL | Map entries are removed regardless of the value for form type. |
Job name. The name of the job that created the spooled file. This field can be used in conjunction with any of the other values in the Remove criteria format to select a list of entries to remove.
The following special values can be used for the job name:
| *ALL | Map entries are removed regardless of the value for job name. |
Mail tag. The value of the mail tag for a spooled file or a spooled file segment. This field can be used in conjunction with any of the other values in the Remove criteria format to select a list of entries to remove.
The following special values can be used for mail tag:
| *ALL | Map entries are removed regardless of the value for mail tag. |
Output queue library name. The name of the library where the output queue resides.
The following special values can be used for the output queue library name:
| *CURLIB | The current library for the current job. |
| *LIBL | The library list of the current job. |
Output queue name. The name of the output queue in which the spooled file is located. At least one output queue or special value must be specified. This field can be used in conjunction with any of the other values in the Remove criteria format to select a list of entries to remove.
The following special values can be used for the output queue name:
| *ALL | Map entries are removed regardless of the value for output queue name. |
Sequence number. The user-defined sequence number for an entry.
| X'00000000' | All entries will be examined. If an entry is non-segmented and it matches the remove criteria, then it is removed. If an entry is segmented, only those segments that match the remove criteria will be removed. |
| sequence-number | The sequence number of an entry. A single entry will be examined. If the entry is non-segmented and it matches the remove criteria, then it is removed. If an entry is segmented, only segments that match the remove criteria will be removed. |
This field can be used in conjunction with any of the other values in the Remove criteria format to select a list of entries to remove.
Spooled file name. The name of the spooled file. At least one output queue or special value must be specified. This field can be used in conjunction with any of the other values in the Remove criteria format to select a list of entries to remove.
The following special value is used for the output queue name:
| *ALL | Map entries are removed regardless of the spooled file name. |
User data. The value of the user data. At least one user name or special value must be specified. This field can be used in conjunction with any of the other values in the Remove criteria format to select a list of entries to remove.
The following special value is used for the user data:
| *ALL | Map entries are removed regardless of the user data. |
User name. The name of the user that created the spooled file. At least one user name or special value must be specified. This field can be used in conjunction with any of the other values in the Remove criteria format to select a list of entries to remove.
The following special value is used for the output queue name:
| *ALL | Map entries are removed regardless of the user name. |
| Message ID | Error Message Text |
|---|---|
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C70 E | Length of entries removed parameter is not valid. |
| CPF3C76 E | Length of lengths and offsets of entries &1 is not valid. |
| CPF3C79 E | Maximum number of entries &1 is not valid. |
| CPD5F01 D | API &5 detected an internal system failure. |
| CPF9801 E | Object &2 in library &3 not found. |
| CPF9802 E | Not authorized to object &2 in &3. |
| CPF9810 E | Library &1 not found. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| Top | Print APIs | API by category |