Open List of PDF Map Information (QPQOLPM) API
Required Parameter Group:
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | List information | Output | Char(80) |
| 4 | Number of records to return | Input | Binary(4) |
| 5 | Format name | Input | Char(8) |
| 6 | Filter information | Input | Char(*) |
| 7 | Format of filter information | Input | Char(8) |
| 8 | Qualified Map object name | Input | Char(20) |
| 9 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: Yes
The Open List of PDF Map Information (QPQOLPM) API lists entries from a PDF Map object and places the list in a receiver variable. The size of the receiver variable determines the amount of information returned. You can access additional records by using the Get List Entries (QGYGTLE) API. On successful completion of the API, a handle is returned in the list information parameter. You may use this handle on subsequent calls to the following APIs:
- Get List Entries (QGYGTLE)
- Close List (QGYCLST)
For more information, see Process Open List APIs.
Authorities and Locks
- Library authority
- *EXECUTE
- PDF Map object authority
- *USE
- PDF Map object lock
- *SHRRD
Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data the area can hold.
- Length of Receiver variable
- INPUT; BINARY(4)
The length of the receiver variable provided. This must be large enough to hold at least one record.
- List information
- OUTPUT; CHAR(80)
Information about the list of objects that was opened. For a description of the layout of this parameter, see Open list information format.
- Number of records to return
- INPUT; BINARY(4)
The number of records in the list to put into the receiver variable.
- Format name
- INPUT; CHAR(8)
The format of the information to be returned for the specified object. The valid format names are:
PDFM0100 Contains abbreviated information about a single entry from the specified Map object. The format is repeated for each entry in the specified Map object. If an entry is segmented, there is just a single entry; there is not an entry for each segment. PDFM0200 Contains all information about a single entry from the specified Map object. The format is repeated for each entry in the specified Map object. If an entry is segmented, there is an entry for each segment.
- Filter information
- INPUT; CHAR(*)
The information in this parameter is used for filtering the list of Map information. You must specify the filter format you are using with the Format of filter information parameter..
- Format of filter information
- INPUT; CHAR(8)
The format of the filter information that can be specified for retrieving entries from a Map object. The valid format name is:
FLTR0100 Use this format to specify which entries should be listed. You can have all entries, or a subset of the entries in a Map object listed. - Qualified Map object name
- INPUT; CHAR(20)
The Map object for which you would like to retrieve information. The qualified object name has two parts. The first 10 characters contain the object name.
The second 10 characters contain the name of the library in which the object is located.
The following special values are allowed:
*CURLIB The job's current library is used to locate the object. If no library is specified as the current library for the job, the QGPL library is used. *LIBL The library list is used to locate the object.
The actual library that is used is returned with the object information.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
PDFM0100 Format
The following table shows the information returned for the PDFM0100 format. If necessary, text fields are padded with blanks (X'40'). For more details about the fields in the this table, see PDFM0100 Format Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Sequence number of entry |
| 4 | 4 | CHAR(10) | Output queue name for input spooled file |
| 14 | E | CHAR(10) | Output queue library name for input spooled file |
| 24 | 18 | CHAR(10) | Spooled file name for input spooled file |
| 34 | 22 | CHAR(10) | Job name for input spooled file |
| 44 | 2C | CHAR(10) | User name for input spooled file |
| 54 | 36 | CHAR(10) | User data for input spooled file |
| 64 | 40 | CHAR(10) | Form type for input spooled file |
| 74 | 4A | CHAR(250) | Mail tag for input spooled file |
| 324 | 144 | CHAR(1) | Segmented entry |
| 325 | 145 | CHAR(50) | Text description |
| 375 | 177 | CHAR(1) | Reserved |
PDFM0100 Format Field Descriptions
Form type for input spooled file. The type of forms that should be loaded on the printer before this spooled file is printed. This is the value for the input spooled file.
The following special values can be used for the form type for input spooled file:
| *ALL | The entry is included in the list regardless of the value for form type for filter. |
Job name for input spooled file. The name of the job that produced the input spooled file.
The following special values can be used for the job name for input spooled file:
| *ALL | The entry is included in the list regardless of the value for job name for filter. |
Mail tag for input spooled file. The value of the mail tag for the input spooled file.
The following special values can be used for mail tag for input spooled file:
| *ALL | The entry is included in the list regardless of the value for mail tag for filter. |
Output queue library name for input spooled file. The name of the library where the output queue for the input spooled file resides.
If Output queue name for input spooled file has a value of *ALL, than this field is set to blanks.
Output queue name for input spooled file. The name of the output queue where the input spooled file resides.
The following special values can be used for the output queue name for input spooled file:
| *ALL | The entry is included in the list regardless of the value for output queue name for filter. |
Reserved. Set to a null value.
Segmented entry. Indicates whether an entry is a segment.
The following values are used:
| 1 | The entry is a segment. |
| 0 | The entry is not a segment. |
Sequence number of entry. The user-defined sequence number for an entry in a PDF Map object.
Spooled file name for input spooled file. The name of the existing spooled file.
The following special values can be used for the spooled file name for input spooled file:
| *ALL | The entry is included in the list regardless of the value for spooled file name for filter. |
Text description. A brief description of the PDF Map entry.
User data for input spooled file. The user-specified data which describe the input spooled file.
The following special values can be used for the user data for input spooled file:
| *ALL | The entry is included in the list regardless of the value for user data for filter. |
User name for input spooled file. The name of the user that created the spooled file.
The following special values can be used for the user name for input spooled file:
| *ALL | The entry is included in the list regardless of the value for user name for filter. |
PDFM0200 Format
The following table shows the information returned for the PDFM0200 format. If necessary, text fields are padded with blanks (X'40'). For more details about the fields in the this table, see PDFM0200 Format Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of PDF Map entry |
| 4 | 4 | BINARY(4) | Sequence number of entry |
| 8 | 8 | BINARY(4) | Offset to mail information entry |
| 12 | C | BINARY(4) | Length of mail information entry |
| 16 | 10 | BINARY(4) | Offset to PDF stream file information |
| 20 | 14 | BINARY(4) | Length of PDF stream file information |
| 24 | 18 | BINARY(4) | Offset to PDF spooled file information |
| 28 | 1C | BINARY(4) | Length of PDF spooled file information |
| 32 | 20 | BINARY(4) | Offset to AFPDS spooled file information |
| 36 | 24 | BINARY(4) | Length of AFPDS spooled file information |
| 40 | 28 | CHAR(10) | Output queue name for input spooled file |
| 50 | 32 | CHAR(10) | Output queue library name for input spooled file |
| 60 | 3C | CHAR(10) | Spooled file name for input spooled file |
| 70 | 46 | CHAR(10) | Job name for input spooled file |
| 80 | 50 | CHAR(10) | User name for input spooled file |
| 90 | 5A | CHAR(10) | User data for input spooled file |
| 100 | 64 | CHAR(10) | Form type for input spooled file |
| 110 | 6E | CHAR(250) | Mail tag for input spooled file |
| 360 | 168 | CHAR(1) | Segmented entry |
| 361 | 169 | CHAR(50) | Text description |
| 411 | 19B | CHAR(1) | Reserved |
PDFM0200 Format Field Descriptions
Form type for input spooled file. The type of forms that should be loaded on the printer before this spooled file is printed. This is the value for the input spooled file.
The following special values can be used for the form type for input spooled file:
| *ALL | The entry is included in the list regardless of the value for form type for filter. |
Job name for input spooled file. The name of the job that produced the input spooled file.
The following special values can be used for the job name for input spooled file:
| *ALL | The entry is included in the list regardless of the value for job name for filter. |
Length of AFPDS spooled file information. The size, in bytes, of an AFPDS Spooled File Information entry. If there is an entry (this field has a value greater than 0), there is a maximum of one entry for each non-segmented entry, and one entry for each segment of a segmented entry. For information on the format of an AFPDS Spooled File Information entry, see AFPDS Spooled File Information Entry.
Length of mail information entry. The size, in bytes, of a single Mail information entry. If there is an entry (this field has a value greater than 0), there is a maximum of one entry for each non-segmented entry, and one entry for each segment of a segmented entry. For information on the format of a mail information entry, see Mail Information Entry.
Length of PDF Map entry. The size, in bytes, of a single PDF Map entry for format PDFM0200. The length includes, in addition to the PDFM0200 format, all entries required to provide the data for one PDF Map entry. There is one PDF Map entry for each non-segmented entry, and one PDF Map entry for each segment of a segmented entry in the Map object. The entries are placed contiguously in storage. For information on the format of a PDF Map entry, see PDFM0200 Format. The number of PDF Map entries returned corresponds to the value in the Records returned field in the Open list information format.
Length of PDF spooled file information. The size, in bytes, of a PDF Spooled File Information entry. For information on the format of a PDF Spooled File Information Entry, see PDF Spooled File Information Entry.
Length of PDF stream file information. The size, in bytes, of a PDF Stream File Information Entry. This identifies the path where PSF/400 has written the PDF stream file. If there is an entry (this field has a value greater than 0), there is a maximum of one entry for each non-segmented entry, and one entry for each segment of a segmented entry. For information on the format of a stream file entry, see PDF Stream File Information Entry.
Mail tag for input spooled file. The value of the mail tag for the input spooled file.
The following special values can be used for mail tag for input spooled file:
| *ALL | The entry is included in the list regardless of the value for mail tag for filter. |
Offset to AFPDS spooled file information. The offset, in bytes, from the beginning of the PDFM0200 format structure, to an AFPDS Spooled File Information entry. If this value is 0, an AFPDS Spooled File Information entry is not specified.
Offset to mail information entry. The offset, in bytes, from the beginning of the PDFM0200 format, to a Mail information entry. If this value is 0, a Mail information entry is not specified.
Offset to PDF spooled file information. The offset, in bytes, from the beginning of the PDFM0200 format, to a PDF Spooled File Information entry. If this value is 0, a PDF Spooled File information entry is not specified.
Offset to PDF stream file information. The offset, in bytes, from the beginning of the PDFM0200 format, to a PDF Stream File Information entry. If this value is 0, a PDF Stream File Information entry is not specified.
Output queue library name for input spooled file. The name of the library where the output queue for the input spooled file resides.
If Output queue name for input spooled file has a value of *ALL, than this field must be set to blanks.
Output queue name for input spooled file. The name of the output queue where the input spooled file resides.
The following special values can be used for the output queue name for input spooled file:
| *ALL | The entry is included in the list regardless of the value for output queue name for filter. |
Reserved. Set to a null value.
Segmented entry. Indicates whether an entry is a segment.
The following values are used:
| 1 | The entry is a segment. |
| 0 | The entry is not a segment. |
Sequence number of entry. The user-defined sequence number for an entry in a PDF Map object.
Spooled file name for input spooled file. The name of the existing spooled file.
The following special values can be used for the spooled file name for input spooled file:
| *ALL | The entry is included in the list regardless of the value for spooled file name for filter. |
Text description. A brief description of the PDF Map entry.
User data for input spooled file. The user-specified data which describe the input spooled file.
The following special values can be used for the user data for input spooled file:
| *ALL | The entry is included in the list regardless of the value for user data for filter. |
User name for input spooled file. The name of the user that created the spooled file.
The following special values can be used for the user name for input spooled file:
| *ALL | The entry is included in the list regardless of the value for user name for filter. |
Mail Information Entry
If necessary, text fields are padded with blanks (X'40'). For more details about the fields in the following table, see Mail Information Entry Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Offset to message text |
| 4 | 4 | BINARY(4) | Length of message text |
| 8 | 8 | BINARY(4) | Offset to subject |
| 12 | C | BINARY(4) | Length of subject |
| 16 | 10 | BINARY(4) | CCSID of message text and subject |
| 20 | 14 | BINARY(4) | Offset to ReplyTo e-mail address |
| 24 | 18 | BINARY(4) | Length of ReplyTo e-mail address |
| 28 | 1C | BINARY(4) | Offset to TO e-mail address entries |
| 32 | 20 | BINARY(4) | Number of TO e-mail address entries |
| 36 | 24 | BINARY(4) | Length of TO e-mail address entry |
| 40 | 28 | BINARY(4) | Offset to CC e-mail address entries |
| 44 | 2C | BINARY(4) | Number of CC e-mail address entries |
| 48 | 30 | BINARY(4) | Length of CC e-mail address entry |
| 52 | 34 | BINARY(4) | Offset to BCC e-mail address entries |
| 56 | 38 | BINARY(4) | Number of BCC e-mail address entries |
| 60 | 3C | BINARY(4) | Length of BCC e-mail address entry |
| 64 | 40 | BINARY(4) | Offset to Body of e-mail entries |
| 68 | 44 | BINARY(4) | Number of Body of e-mail entries |
| 72 | 48 | BINARY(4) | Length of Body of e-mail entry |
| 76 | 4C | BINARY(4) | Offset to attachment e-mail entries |
| 80 | 50 | BINARY(4) | Number of attachment e-mail entries |
| 84 | 54 | BINARY(4) | Length of attachment e-mail entry |
| 88 | 58 | BINARY(4) | Offset to TO e-mail stream file |
| 92 | 5C | BINARY(4) | Length of TO e-mail stream file |
| 96 | 60 | BINARY(4) | Offset to CC e-mail stream file |
| 100 | 64 | BINARY(4) | Length of CC e-mail stream file |
| 104 | 68 | BINARY(4) | Offset to BCC e-mail stream file |
| 108 | 6C | BINARY(4) | Length of BCC e-mail stream file |
| 112 | 70 | BINARY(4) | Offset to PDF file for e-mail |
| 116 | 74 | BINARY(4) | Length of PDF file for e-mail |
| 120 | 78 | CHAR(10) | Mail Sender |
| 130 | 82 | CHAR(10) | User password |
| 140 | 8C | CHAR(10) | Master password |
| 150 | 96 | CHAR(1) | Encryption level |
| 151 | 97 | CHAR(1) | Print PDF file |
| 152 | 98 | CHAR(1) | Copy PDF file |
| 153 | 99 | CHAR(1) | Change PDF file |
| 154 | 9A | CHAR(1) | Change Comments in PDF file |
| 155 | 9B | CHAR(1) | Content Access to PDF file |
| 156 | 9C | CHAR(1) | Document assembly |
| 157 | 9D | CHAR(1) | Use stream file for TO e-mail address entries |
| 158 | 9E | CHAR(1) | Use stream file for CC e-mail address entries |
| 159 | 9F | CHAR(1) | Use stream file for BCC e-mail address entries |
Mail Information Entry Field Descriptions
CCSID of message text and subject. The CCSID associated with the message text and subject.
Change Comments in PDF file. Specifies whether users are allowed to add or change comments (annotations) or form fields in the PDF file. This field is applicable for Encryption levels *40RC4 and *128RC4.
The following values are used:
| X'F0' | The user is not allowed to change comments in the PDF file. |
| X'F1' | The user is allowed to change comments in the PDF file. |
Change PDF file. Specifies whether users are allowed to change the PDF file. This field is applicable for Encryption levels *40RC4 and *128RC4.
The following values are used:
| X'F0' | The user is not allowed to change the PDF file. |
| X'F1' | The user is allowed to change the PDF file. |
Content Access to PDF file. Specifies whether content accessibility for the visually impaired is enabled for the PDF file. This field is applicable only for an Encryption level of *128RC4.
The following values are used:
| X'F0' | Content accessibility for the visually impaired is disabled in the PDF file. . |
| X'F1' | content accessibility for the visually impaired is enabled in the PDF file.. |
Copy PDF file. Specifies whether users are allowed to copy or extract text and graphics. This field is applicable for Encryption levels *40RC4 and *128RC4.
The following values are used:
| X'F0' | The user is not allowed to copy and extract text and graphics in the PDF file. The accessibility interface is disabled. |
| X'F1' | The user is allowed to copy and extract text and graphics in the PDF file. The accessibility interface is enabled. |
Document assembly of PDF file. Specifies whether users are allowed to assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images). This field is applicable for an Encryption level of *128RC4 only.
The following values are used:
| X'F0' | The user is not allowed to assemble the document |
| X'F1' | The user is allowed to assemble the document |
Encryption level. The encryption level for the PDF file. If the encryption level is *40RC4 or *128RC4, then the different encryption options valid for those levels of security will be returned.
The following special values are used for the encryption level:
| X'F0' | The file is not encrypted. |
| X'F1' | The PDF file is created with the 40-bit RC4 encryption level. This level of encryption has a lower level of security that is compatible with Adobe Acrobat Reader 3.X and later versions. |
| X'F2' | The PDF file is created with the 128-bit RC4 encryption level. This level of encryption is has a higher level of security but is only compatible with Adobe Acrobat 5.X and later versions. |
Length of attachment e-mail entry. The size, in bytes, of each entry used for naming an e-mail attachment. Use one entry for each stream file. The entries must be concatenated, as in an array. For information on the format of a stream file entry, see Stream File Entry.
Length of BCC e-mail address entry. The size, in bytes, of each E-mail Address entry used for the BCC of an e-mail. For information on the format of an e-mail addresses entry, see E-mail Address Entry.
If Use stream file for BCC e-mail address entries is set to X'F1', then this value will be 0.
Length of BCC e-mail stream file. The size, in bytes, of the Stream File entry containing the stream file which lists the BCCs used for an e-mail. For information on the format of an e-mail addresses entry, see Stream File Entry.
If Use stream file for BCC e-mail address entries is set to X'F0', then this value will be 0.
Length of Body of e-mail entry. The size, in bytes, of each entry used for naming a stream file placed into the body of the e-mail. Use one entry for each stream file. The entries must be concatenated, as in an array. For information on the format of a stream file entry, see Stream File Entry.
Length of CC e-mail address entry. The size, in bytes, of each E-mail Address entry used for the CC of an e-mail. For information on the format of an e-mail addresses entry, see E-mail Address Entry.
If Use stream file for CC e-mail address entries is set to X'F1', then this value will be 0.
Length of CC e-mail stream file. The size, in bytes, of the Stream File entry containing the stream file which lists the CCs used for an e-mail. For information on the format of a stream file entry, see Stream File Entry.
If Use stream file for CC e-mail address entries is set to X'F0', then this value will be 0.
Length of message text. The size, in bytes, of the message text that gets placed into the body of the e-mail.
The following special values can be used for the message text:
| *NONE | No message text will be included in the body of the e-mail. |
If the length of the message text is 0, then the default message text is obtained from message PQT4133 in message file QPQMSGF.
Length of PDF file for e-mail The size, in bytes, of a File Name Entry. This identifies the name to be used for the PDF file produced from a spooled file, that is attached to an e-mail. For information on the format of a file name entry, see File Name Entry.
Length of ReplyTo to e-mail address. The size, in bytes, of an E-mail Address entry used for the ReplyTo of an e-mail. For information on the format of an e-mail addresses entry, see E-mail Address Entry.
The following special values can be used for the ReplyTo e-mail address:
| *MAILSENDER | Replies will be sent to the FROM e-mail address. |
Length of subject. The size, in bytes, of the text that is used for the subject of the e-mail.
The following special values can be used for the subject:
Length of subject. The size, in bytes, of the text that is used for the subject of the e-mail.
The following special values can be used for the subject:
| *NONE | No subject will be used in the body of the e-mail. |
If the length of the subject is 0, then the default subject is obtained from message PQT4133 in message file QPQMSGF.
Length of TO e-mail address entry. The size, in bytes, of each E-mail Address entry used for the TO of an e-mail. For information on the format of an e-mail addresses entry, see E-mail Address Entry.
If Use stream file for TO e-mail address entries is set to X'F1', then this value will be 0.
The following special values can be used for the TO e-mail address entry:
| *SPLF | The e-mail address to be used is specified as an attribute of the spooled file (USRDFNDTA('MAILTAG(e-mail-address)' parameter). |
Length of TO e-mail stream file. The size, in bytes, of the Stream File entry containing the stream file which lists the TOs used for an e-mail. If the stream file name is surrounded by quotes, use all characters within the quotes as the stream file name. For information on the format of an e-mail addresses entry, see Stream File Entry.
If Use stream file for TO e-mail address entries is set to X'F0', then this value will be 0.
Master password. The master password associated with the PDF file to be created. Either an encrypted value or a special value in clear text is returned.
This field is applicable for Encryption levels *40RC4 and *128RC4.
The following special value can be used for the master password:
| *NONE | No master password is specified for the PDF file. |
Mail Sender. The user profile from whom the e-mail is being sent.
The following special values can be used for the mail sender:
| *PSFCFG | The mail sender specified on the PSF configuration object will be used for the mail sender. |
Number of attachment e-mail entries. The number of stream files to be attached to the e-mail. This value does not include the spooled file converted to PDF.
Number of BCC e-mail address entries. The number of BCC e-mail addresses to be used for sending an e-mail.
If Use stream file for BCC e-mail address entries is set to X'F1', then this value will be 0.
Number of Body of e-mail entries. The number of stream files to be placed into the body of the e-mail.
Number of CC e-mail address entries. The number of CC e-mail addresses to be used for sending an e-mail.
If Use stream file for CC e-mail address entries is set to X'F1', then this value will be 0.
Number of TO e-mail address entries. The number of TO e-mail addresses to be used for sending an e-mail.
If Use stream file for TO e-mail address entries is set to X'F1', then this value will be 0.
If Use stream file for TO e-mail address entries is set to X'F1', then this value will be 0.
Offset to attachment e-mail entries. The offset, in bytes, from the beginning of the PDFM0200 format structure, to a list of attachment entries. If this value is 0, a list of attachment entries is not specified.
Offset to BCC e-mail address entries. The offset, in bytes, from the beginning of the PDFM0200 format structure, to a list of BCC e-mail address entries. This area contains the BCC e-mail addresses to which the PDF file is sent.
If Use stream file for BCC e-mail address entries is set to X'F1', then this value will be 0.
Offset to BCC e-mail stream file. The offset, in bytes, from the beginning of the PDFM0200 format structure, to a file name which contains a list of BCC e-mail address entries.
If Use stream file for BCC e-mail address entries is set to X'F0', then this value will be 0.
Offset to Body of e-mail entries. The offset, in bytes, from the beginning of the PDFM0200 format structure, to a list of Stream file entries. If this value is 0, a list of Stream file entries is not specified.
Offset to CC e-mail address entries. The offset, in bytes, from the beginning of the PDFM0200 format structure, to a list of CC e-mail address entries. This area contains the CC e-mail addresses to which the PDF file is sent.
If Use stream file for CC e-mail address entries is set to X'F1', then this value will be 0.
Offset to CC e-mail stream file. The offset, in bytes, from the beginning of the PDFM0200 format structure, to a file name which contains a list of CC e-mail address entries.
If Use stream file for CC e-mail address entries is set to X'F0', then this value will be 0.
Offset to message text. The offset, in bytes, from the beginning of the PDFM0200 format, to the message text which gets placed in to the body of the e-mail. If this value is 0, message text is not specified.
Offset to PDF file for e-mail The offset, in bytes, from the beginning of the PDFM0200 format, to the PDF File For E-mail Entry.
Offset to ReplyTo e-mail address. The offset, in bytes, from the beginning of the PDFM0200 format, to the E-mail ddress Entry for a ReplyTo e-mail address. If this value is 0, a ReplyTo e-mail address is not specified.
Offset to subject. The offset, in bytes, to the subject of the e-mail. If this value is 0, a subject is not specified.
Offset to TO e-mail address entries. The offset, in bytes, from the beginning of the PDFM0200 format, to to a list of TO e-mail address entries. This area contains the TO e-mail addresses to which the PDF file is sent.
Offset to TO e-mail stream file. The offset, in bytes, from the beginning of the PDFM0200 format, to a file name which contains a list of TO e-mail address entries.
If Use stream file for TO e-mail address entries is set to X'F0', then this value will be 0.
Print PDF file. Specifies whether users are allow to print the PDF file. This field is applicable for Encryption levels *40RC4 and *128RC4. An additional value is available for an Encryption level of *128RC4.
| X'F0' | The user is not allowed to print the PDF file. |
| X'F1' | The user is allowed to print the PDF file. |
| X'F2' | The user is only allowed to print at a low resolution (image). This prevents the user from recreating the PDF file with different security settings. Printing may be slower because each page will be printed as a bit-mapped image. This value can be returned only for an Encryption level of *128RC4. |
Use stream file for BCC e-mail address entries. Indicates if a stream file containing BCC e-mail addresses is being used.
The following values are used:
| X'F0' | A stream file for BCC e-mail address entries is not being used. |
| X'F1' | A stream file for BCC e-mail address entries is being used. |
Use stream file for CC e-mail address entries. Indicates if a stream file containing CC e-mail addresses is being used.
The following values are used:
| X'F0' | A stream file for CC e-mail address entries is not being used. |
| X'F1' | A stream file for CC e-mail address entries is being used. |
Reserved. Set to a null value.
Use stream file for TO e-mail address entries. Indicates if a stream file containing TO e-mail addresses is being used.
The following values are used:
| X'F0' | A stream file for TO e-mail address entries is not being used. |
| X'F1' | A stream file for TO e-mail address entries is being used. |
User password. The user password associated with the PDF file to be created. Either an encrypted value or a special value in clear text is returned.
This field is applicable for Encryption levels *40RC4 and *128RC4.
The following special value can be used for the user password:
| *NONE | No user password is specified for the PDF file. |
E-mail Address Entry
This table is used for mapping the TO, CC, BCC and ReplyTo e-mail addresses. If necessary, the field is padded with blanks (X'40'). For more details about the fields that can be used with the following table, see E-mail Address Entry Field Description.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(80) | E-mail address |
E-mail Address Entry Field Description
E-mail address. An e-mail address.
Stream File Entry
This table is used for mapping the stream files that can be used for the Body, Attachment, TO, CC, and BCC stream files. Use one entry for each stream file. If you are specifying a stream file for the Body, the file extension (for example, txt or htm) must be specified in lower case. Otherwise, the file will be sent as an attachment. If necessary, the field is padded with blanks (X'40'). For more details about the field that can be used with the following table, see Stream File Entry Field Description.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(255) | Stream file name |
Stream File Entry Field Description
Stream file name. A path-qualified stream file name.
PDF Stream File Information Entry
If necessary, the Public Authority field is padded with blanks (X'40'). For more details about the fields in the following table, see PDF Stream File Information Entry Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Offset to PDF file name |
| 4 | 4 | BINARY(4) | Length of PDF file name |
| 8 | 8 | CHAR(10) | Public Authority |
| 18 | 11 | CHAR(2) | Reserved |
PDF Stream File Information Entry Field Descriptions
Length of PDF file name. The size, in bytes, of the Stream File entry which contains the PDF file name. For information on the format of a Stream File entry, see Stream File Entry.
Offset to PDF file name. The offset, in bytes, from the beginning of the PDFM0200 format, to the Stream File entry for a PDF file.
Public Authority. The public authority for the PDF stream file. The default is *EXCLUDE.
The following special values may be specified:
| *EXCLUDE | Users are excluded from accessing the object. |
| *RWX | Users are given *RWX authority to perform all operations on the object except those limited to the master or controlled by object existence, object management, object alter, and object reference authority. Users can change the object and perform basic functions on the object. *RWX authority provides object operational authority and all the data authorities. |
| *RX | The users are given *RX authority to perform basic operations on object, such as run a program or display the contents of a file. The user is prevented from changing the object. *RX authority provides object operational authority and read and execute authorities. |
| *RW | The users are given *RW authority to view the contents of an object and change the contents of an object. *RW authority provides object operational authority and data read, add, update, and delete authorities. |
| *WX | Users are given *WX authority to change the contents of an object and run a program or search a library or directory. *WX authority provides object operational authority and data add, update, delete, and execute authorities. |
| *R | Users are given *R authority to view the contents of an object. *R authority provides object operational authority and data read authority. |
| *W | Users are given *W authority to change the contents of an object. *W authority provides object operational authority and data add, update, and delete authorities. |
| *X | users are given *X authority to run a program or search a library or directory. *X authority provides object operational authority and data execute authority. |
Reserved. Set to a null value.
PDF Spooled File Information Entry
These fields are used for mapping the PDF spooled file information. If necessary, text fields are padded with blanks (X'40'). For more details about the fields in the following table, see PDF and AFPDS Spooled File Information Entry Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Output queue name for output spooled file |
| 10 | A | CHAR(10) | Output queue library name for output spooled file |
| 20 | 14 | CHAR(10) | Spooled file name for output spooled file |
| 30 | 1E | CHAR(10) | User data for output spooled file |
| 40 | 28 | CHAR(10) | Form type for output spooled file |
| 50 | 32 | CHAR(255) | User defined data for output spooled file |
| 305 | 13B | CHAR(3) | Reserved |
AFPDS Spooled File Information Entry
These fields are used for mapping the AFPDS spooled file information. If necessary, text fields are padded with blanks (X'40'). For more details about the fields in the following table, see PDF and AFPDS Spooled File Information Entry Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Output queue name for output spooled file |
| 10 | A | CHAR(10) | Output queue library name for output spooled file |
| 20 | 14 | CHAR(10) | Spooled file name for output spooled file |
| 30 | 1E | CHAR(10) | User data for output spooled file |
| 40 | 28 | CHAR(10) | Form type for output spooled file |
| 50 | 32 | CHAR(255) | User defined data for output spooled file |
| 305 | 13B | CHAR(3) | Reserved |
PDF and AFPDS Spooled File Information Entry Field Descriptions
Form type for output spooled file. The type of forms that should be loaded on the printer before this spooled file is printed. This is the value which will be used when a file is spooled.
The following special values can be used for the form type for output spooled file:
| *SPLF | The form type of the original spooled file will be used. |
Output queue library name for output spooled file. The name of the library where the output queue for the file which will be spooled resides.
Output queue name for output spooled file. The name of the output queue to which the file to be spooled will be written.
The following special values can be used for the form type for output queue name for output spooled file:
| *PSFCFG | The output queue specified in the PSF configuration object will be used when writing the PDF file to spool. |
Reserved. Set to a null value.
Spooled file name for output spooled file. The name which will be used for the file that gets spooled.
The following special values can be used for the spooled file name for output spooled file:
| *SPLF | The name of the original spooled file will be used. |
User data for output spooled file. The user-specified data which will describe the file to be spooled.
The following special values can be used for the user data for output spooled file:
| *SPLF | The user data of the original spooled file will be used. |
User defined data for output spooled file. The user-defined data that will be used for the file to be spooled.
The following special values can be used for the user defined data for output spooled file:
| *SPLF | The user defined data of the original spooled file will be used. |
File Name Entry
This table is used for mapping a file name that is not path-qualifed. Use this entry for mapping a PDF file for e-mail entry. If necessary, the field is padded with blanks (X'40'). For more details about the field that can be used with the following table, see File Name Entry Field Description.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(80) | File name |
File Name Entry Field Description
File name. A file name which does not contain path information.
FLTR0100 Format
The following table shows the information provided for the FLTR0100 format. If necessary, use blanks (X'40') as the pad character for text fields. For more details about the fields in the following table, see FLTR0100 format Field Descriptions.
The minimum length that can be specified for this format, using field Length of filter information, is 8. For any fields not included due to the length specification, a value of *ALL will be used.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of filter information |
| 4 | 4 | BINARY(4) | Sequence number for filter |
| 8 | 8 | CHAR(10) | Output queue name for filter |
| 18 | 12 | CHAR(10) | Output queue library name for filter |
| 28 | 1A | CHAR(10) | Spooled file name for filter |
| 38 | 26 | CHAR(10) | Job name for filter |
| 48 | 30 | CHAR(10) | User name for filter |
| 58 | 3A | CHAR(10) | User data for filter |
| 68 | 44 | CHAR(10) | Form type for filter |
| 78 | 4E | CHAR(250) | Mail tag for filter |
FLTR0100 Format Field Descriptions
Form type for filter. 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 filter values to subset the list of Map entries.
The following special values can be used for the form type for filter:
| *ALL | Map entries are included in the list regardless of the value for form type. |
This field must be padded with blanks (X'40').
Job name for filter. The name of the job that created the spooled file. This field can be used in conjunction with any of the other filter values to subset the list of Map entries.
The following special values can be used for the form type for filter:
| *ALL | Map entries are included in the list regardless of the value for job name. |
Length of filter information. The size, in bytes, of the Filter Information Format FLTR0100. The minimum length that can be specified is 8. For any fields not included due to the length specification,a value of *ALL will be used.
For information on the Filter Information Format, see FLTR0100 Format.
Mail tag for filter. The value of the mail tag that matches this value are included in the list.
This field can be used in conjunction with any of the other filter values to subset the list of Map entries.
Here is information on specifying a mail tag for filter:
- Embedded blanks will be used as part of the mail tag.
- If necessary, the field must be padded with blanks (X'40').
- Do not use single quotes around the text string, as they will be interpreted as part of the text string.
- Case is preserved.
The following special values can be used for the mail tag:
| *ALL | Map entries are included in the list regardless of the value for mail tag. |
Output queue library name for filter. The name of the library where the output queue resides.
The following special value can be used for the output queue library name when filtering:
| *CURLIB | The current library for the current job. |
| *LIBL | The library list of the current job. |
| *ALL | Map entries are included in the list regardless of the output queue library name. When this value is specified, the output queue library name must not be blank and must not have a value of *ALL. |
Output queue name for filter. The name of the output queue to filter on or 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 filter values to subset the list of Map entries.
The following special value is used for the output queue name when filtering:
| *ALL | Map entries are included in the list regardless of the output queue name. When this value is specified, the output queue library name must be blanks. |
This field must be padded with blanks (X'40').
Sequence number for filter. The user-defined sequence number on which to filter.
The following values are used:
| X'00000000' | All entries will be searched. If a listed entry is non-segmented, all of the entry's information for the specified format is provided. If a listed entry is segmented, just the base portion of the entry is provided; information on individual segments is not provided. The base portion of a segmented entry consists of the following: Sequence number of entry, Output queue name for input spooled file, Output queue library name for input spooled file, User name for input spooled file, User data for input spooled file, Form type for input spooled file and Segmented entry. Fields not used in a specified format will be set to blanks ('40'X) for character data, 0 for numeric fields and '00'X for reserved fields. |
| X'FFFFFFFF' | All entries will be searched. If a listed entry is non-segmented, all of the entry's information for the specified format is provided. If a listed entry is segmented, each segment's information for the specified format is provided. |
| sequence-number | The sequence number of an entry. If a listed entry is non-segmented, all of the entry's information for the specified format is provided. If a listed entry is segmented, all information for the specified format for each segment is provided. The values for the filter determine whether all segments or a subset of the segments are returned. |
This field can be used in conjunction with any of the other filter values to subset the list of Map entries.
Spooled file name for filter. The name of the spooled file to filter on or 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 filter values to subset the list of Map entries.
The following special value is used for the Spooled file name when filtering:
| *ALL | Map entries are included in the list regardless of the spooled file name. |
This field must be padded with blanks (X'40').
User data for filter. The value of the user data of the Map entry to filter on or 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 filter values to subset the list of Map entries.
The following special value is used for the user data when filtering:
| *ALL | Map entries are included in the list regardless of the user data. |
This field must be padded with blanks (X'40').
User name for filter. The name of the user that created the spooled file or the name of the user to filter on. At least one user name or special value must be specified. This field can be used in conjunction with any of the other filter values to subset the list of Map entries.
The following special value is used for the output queue name when filtering:
| *ALL | Map entries are included in the list regardless of the user name for filter. |
This field must be padded with blanks (X'40').
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C3C E | Value for parameter &1 not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPD5F01 D | API &5 detected an internal system failure. |
| CPF5F11 E | Format of filter information name &1 is not valid. |
| CPF5F12 E | Length of filter information &1 is not valid. |
| 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. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V5R3
[ Back to top | Print APIs | APIs by category ]