Retrieve Spooled File Attributes (QUSRSPLA) API

The Retrieve Spooled File Attributes (QUSRSPLA) API returns specific information about a spooled file into a receiver variable. The size of the receiver variable determines the amount of information returned. You can specify the spooled file for which information is returned either with the internal job and spooled file identifiers, or with a specific job name, spooled file name, and spooled file number.

For RPG and COBOL examples using this API, see Examples: APIs and exit programs.

Note: These examples also contain a delete old spooled file (DLTOLDSPLF) example.

Authorities and Locks

None.

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. If the length is larger than the size of the receiver variable, the results are not predictable. The minimum length is 8 bytes.

Format name

INPUT; CHAR(8)

The format of the information to be returned for the specified spooled file.

The valid format names are:

SPLA0100	Basic spooled file attributes.
SPLA0200	Detailed spooled file attributes needed to print or duplicate the spooled file.

Qualified job name

INPUT; CHAR(26)

The job that owns the spooled file.

The qualified job name has three parts:

job name	CHAR(10). A specific job name, or one of the following special values: * Only the job that this program is running. The rest of the job name parameter must be blank. *INT The internal job identifier is used to locate the spooled file. The user name and job number must be set to blank.
user name	CHAR(10). A specific user profile name, or blanks when the job name is * or *INT.
job number	CHAR(6). A specific job number, or blanks when the job name is * or *INT.

Internal job identifier

INPUT; CHAR(16)

The internal job identifier for the job that owns the spooled file whose attributes are to be retrieved. Use one of these APIs to make the identifier available:

• List Spooled Files (QUSLSPL) API
• List Job (QUSLJOB) API
• Retrieve Job Information (QUSRJOBI) API

Internal spooled file identifier

INPUT; CHAR(16)

The internal spooled file identifier for the spooled file whose attributes are retrieved. To make the identifier available, see List Spooled Files (QUSLSPL) API.

Spooled file name

INPUT; CHAR(10)

The name of the spooled file for which you may want to retrieve the attributes.

You can use this special value for the name:

*INT	The internal spooled file identifier is used to locate the spooled file.

Spooled file number

INPUT; BINARY(4)

The unique number of the spooled file. The valid range is 1 through 999999.

The following special values are supported for this parameter:

0	Only one spooled file from the job has the specified file name, so the number of the spooled file is not necessary.
-1	This uses the highest-numbered spooled file with the specified file name.
-2	The spooled file number is not used to determine which spooled file to process. Use this value when you want the Job system name parameter or the Spooled file create date and Spooled file create time parameters to take precedence over the spooled file number when selecting a spooled file.

Note: This parameter must contain a valid value even if the value for the spooled file name parameter is *INT.

A value is required because the QUSRSPLA API performs validity checking on all parameters.

Optional Parameter Group 1

Error code

I/O; CHAR(*)

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

If this parameter is omitted, diagnostic and escape messages are issued to the application.

Optional Parameter Group 2

Job system name

INPUT; CHAR(8)

The name of the system where the job that created the spooled file ran or blank when the spooled file name is *INT. This parameter is considered after the job name, user name, job number, spooled file name, and spooled file number parameter requirements have been met.

The following special values are supported for this parameter:

*ONLY	There is one job with the specified job name, user name, job number, spooled file name, spooled file number, spooled file create date, and spooled file create time.
*CURRENT	The job on the current system with the specified job name, user name, job number, spooled file name, spooled file number, spooled file create date, and spooled file create time is used.
*ANY	The job system name is not considered when selecting a spooled file. Use this value when you want the Spooled file create date and Spooled file create time parameters to take precedence over the job system name when selecting a spooled file.

If this parameter is omitted, the API assumes blanks when the spooled file name is *INT. When spooled file name is not *INT, the API assumes *ONLY.

Spooled file create date

INPUT; CHAR(7)

The date, based on local job time, that the spooled file was created on the system or blank when the spooled file name is *INT. This parameter is considered after the job name, user name, job number, spooled file name, spooled file number, and job system name parameter requirements have been met. The date must be in the CYYMMDD format or one of the following special values:

*ONLY	There is only one spooled file with the specified job name, user name, job number, spooled file name, spooled file number, and job system name.
*LAST	The spooled file with the latest date and time which also has the specified job name, user name, job number, spooled file name, spooled file number, and job system name is used.

The date format CYYMMDD is defined as follows:

C	Century, where 0 indicates years 19xx and 1 indicates years 20xx.
YY	Year
MM	Month
DD	Day

If this parameter is omitted, the API assumes blanks when the spooled file name is *INT. When spooled file name is not *INT, the API assumes *ONLY.

Spooled file create time

INPUT; CHAR(6)

The time, in local job time, that the spooled file was created on the system. This parameter must be set to blanks when special values *LAST or *ONLY are used for parameter Spooled file create date. This parameter must have a value set if a date is specified for parameter Spooled file create date. This parameter is considered after the job name, user name, job number, spooled file name, spooled file number, job system name, and spooled file create date parameter requirements have been met. The time must be in the HHMMSS format or one of the following special values:

*ONLY	There is only one spooled file with the specified job name, user name, job number, spooled file name, spooled file number, job system name, and create date.
*LAST	The spooled file with the latest time which also has the specified job name, user name, job number, spooled file name, spooled file number, job system name, and create date is used.

The time format HHMMSS is defined as follows:

HH	Hour
MM	Minutes
SS	Seconds

If this parameter is omitted, the API assumes blanks.

How to Select a Spooled File to Retrieve Its Attributes

This table illustrates the valid parameter combinations of qualified job name, internal job identifier, internal spooled file identifier, spooled file name, job system name, spooled file create date and spooled file create time. The combinations of these parameters identify the spooled file from which attributes can be retrieved. For example, when the qualified job name parameter value is *, the internal job identifier must be blank, the internal spooled file identifier must be blank, the actual name of the spooled file must be given, and a valid spooled file number must be given.

Qualified Job Name			Internal Job Identifier	Internal Spooled File Identifier	Spooled File Name	Spooled File Number	Job system name	Spooled file create date	Spooled file create time
Job Name	User Name	Job Number
Name	Name	Number	Blanks	Blanks	Name	-2 through 999999	Name, *ONLY, *CURRENT, or *ANY	Date, *ONLY, or *LAST	Time, blanks, *ONLY, or *LAST
Name	Blanks	Number	Blanks	Blanks	Name	-2 through 999999	Name, *ONLY, *CURRENT, or *ANY	Date, *ONLY, or *LAST	Time, blanks, *ONLY, or *LAST
Name	Name	Blanks	Blanks	Blanks	Name	-2 through 999999	Name, *ONLY, *CURRENT, or *ANY	Date, *ONLY, or *LAST	Time, blanks, *ONLY, or *LAST
*	Blanks	Blanks	Blanks	Blanks	Name	-2 through 999999	Name, *ONLY, *CURRENT, or *ANY	Date, *ONLY, or *LAST	Time, blanks, *ONLY, or *LAST
*INT	Blanks	Blanks	Internal job identifier	Internal spooled file identifier	*INT	-2 through 999999	Blanks	Blanks	Blanks
*INT	Blanks	Blanks	Internal job identifier	Blanks	Name	-2 through 999999	Name, *ONLY, *CURRENT, or *ANY	Date, *ONLY, or *LAST	Time, blanks, *ONLY, or *LAST See Note for additional information.

Note: This parameter combination is not valid when a job has been detached from its spooled files or for a spooled file on an independent disk pool. Use of this combination will result in message CPF3C43 or CPD3C43.

SPLA0100 Format

The following table shows the information returned for the SPLA0100 format.

Offset		Type	Field
Dec	Hex
0	0	BINARY(4)	Bytes returned
4	4	BINARY(4)	Bytes available
8	8	CHAR(16)	Internal job identifier
24	18	CHAR(16)	Internal spooled file identifier
40	28	CHAR(10)	Job name
50	32	CHAR(10)	User name
60	3C	CHAR(6)	Job number
66	42	CHAR(10)	Spooled file name
76	4C	BINARY(4)	Spooled file number
80	50	CHAR(10)	Form type
90	5A	CHAR(10)	User-specified data
100	64	CHAR(10)	Status
110	6E	CHAR(10)	File available
120	78	CHAR(10)	Hold file before written
130	82	CHAR(10)	Save file after written
140	8C	BINARY(4)	Total pages
144	90	BINARY(4)	Page or record being written
148	94	BINARY(4)	Starting page
152	98	BINARY(4)	Ending page
156	9C	BINARY(4)	Last page printed
160	A0	BINARY(4)	Restart printing
164	A4	BINARY(4)	Total copies
168	A8	BINARY(4)	Copies left to produce
172	AC	BINARY(4)	Lines per inch
176	B0	BINARY(4)	Characters per inch
180	B4	CHAR(2)	Output priority
182	B6	CHAR(10)	Output queue name
192	C0	CHAR(10)	Output queue library name
202	CA	CHAR(7)	Date file opened (created)
209	D1	CHAR(6)	Time file opened (created)
215	D7	CHAR(10)	Device file name
225	E1	CHAR(10)	Device file library name
235	EB	CHAR(10)	Program that opened file name
245	F5	CHAR(10)	Program that opened file library name
255	FF	CHAR(15)	Accounting code
270	10E	CHAR(30)	Print text
300	12C	BINARY(4)	Record length
304	130	BINARY(4)	Maximum records
308	134	CHAR(10)	Device type
318	13E	CHAR(10)	Printer device type
328	148	CHAR(12)	Document name
340	154	CHAR(64)	Folder name
404	194	CHAR(8)	System/36™ procedure name
412	19C	CHAR(10)	Print fidelity
422	1A6	CHAR(1)	Replace unprintable characters
423	1A7	CHAR(1)	Replacement character
424	1A8	BINARY(4)	Page length
428	1AC	BINARY(4)	Page width
432	1B0	BINARY(4)	Number of separators
436	1B4	BINARY(4)	Overflow line number
440	1B8	CHAR(10)	Multi-byte data
450	1C2	CHAR(10)	DBCS extension characters
460	1CC	CHAR(10)	DBCS shift-out shift-in (SO/SI) spacing
470	1D6	CHAR(10)	DBCS character rotation
480	1E0	BINARY(4)	DBCS characters per inch
484	1E4	CHAR(10)	Graphic character set
494	1EE	CHAR(10)	Code page
504	1F8	CHAR(10)	Form definition name
514	202	CHAR(10)	Form definition library name
524	20C	BINARY(4)	Source drawer
528	210	CHAR(10)	Printer font
538	21A	CHAR(6)	System/36 spooled file identifier
544	220	BINARY(4)	Page rotation
548	224	BINARY(4)	Justification
552	228	CHAR(10)	Print on both sides (duplex)
562	232	CHAR(10)	Fold records
572	23C	CHAR(10)	Control character
582	246	CHAR(10)	Align forms
592	250	CHAR(10)	Print quality
602	25A	CHAR(10)	Form feed
612	264	CHAR(71)	Volumes (array)
683	2AB	CHAR(17)	File label identifier
700	2BC	CHAR(10)	Exchange type
710	2C6	CHAR(10)	Character code
720	2D0	BINARY(4)	Total records
724	2D4	BINARY(4)	Multiple up (pages per side)
728	2D8	CHAR(10)	Front overlay name
738	2E2	CHAR(10)	Front overlay library name
748	2EC	PACKED(15,5)	Front overlay offset down
756	2F4	PACKED(15,5)	Front overlay offset across
764	2FC	CHAR(10)	Back overlay name
774	306	CHAR(10)	Back overlay library name
784	310	PACKED(15,5)	Back overlay offset down
792	318	PACKED(15,5)	Back overlay offset across
800	320	CHAR(10)	Unit of measure
810	32A	CHAR(10)	Page definition name
820	334	CHAR(10)	Page definition library name
830	33E	CHAR(10)	Line spacing
840	348	PACKED(15,5)	Point size
848	350	PACKED(15,5)	Front margin offset down
856	358	PACKED(15,5)	Front margin offset across
864	360	PACKED(15,5)	Back margin offset down
872	368	PACKED(15,5)	Back margin offset across
880	370	PACKED(15,5)	Length of page
888	378	PACKED(15,5)	Width of page
896	380	CHAR(10)	Measurement method
906	38A	CHAR(1)	Advanced Function Presentation™ (AFP™) resource
907	38B	CHAR(10)	Character set name
917	395	CHAR(10)	Character set library name
927	39F	CHAR(10)	Code page name
937	3A9	CHAR(10)	Code page library name
947	3B3	CHAR(10)	Coded font name
957	3BD	CHAR(10)	Coded font library name
967	3C7	CHAR(10)	DBCS-coded font name
977	3D1	CHAR(10)	DBCS-coded font library name
987	3DB	CHAR(10)	User-defined file
997	3E5	CHAR(10)	Reduce output
1007	3EF	CHAR(1)	Constant back overlay
1008	3F0	BINARY(4)	Output bin
1012	3F4	BINARY(4)	CCSID
1016	3F8	CHAR(100)	User-defined text
1116	45C	CHAR(8)	System where file created
1124	464	CHAR(8)	ID where file created
1132	46C	CHAR(10)	User who created file
1142	476	CHAR(2)	Reserved
1144	478	BINARY(4)	Offset to user-defined options
1148	47C	BINARY(4)	Number of user-defined options returned
1152	480	BINARY(4)	Length of each user-defined option entry
1156	484	CHAR(255)	User-defined data
1411	583	CHAR(10)	User-defined object name
1421	58D	CHAR(10)	User-defined object library name
1431	597	CHAR(10)	User object type
1441	5A1	CHAR(3)	Reserved
1444	5A4	PACKED(15,5)	Character set point size
1452	5AC	PACKED(15,5)	Coded font point size
1460	5B4	PACKED(15,5)	DBCS-coded font point size
1468	5BC	BINARY(4)	Auxiliary storage pool
1472	5C0	BINARY(4)	Spooled file size
1476	5C4	BINARY(4)	Spooled file size multiplier
1480	5C8	BINARY(4)	Internet print protocol job identifier
1484	5CC	CHAR(1)	Spooled file creation security method
1485	5CD	CHAR(1)	Spooled file creation authentication method
1486	5CE	CHAR(7)	Date writer began processing spooled file
1493	5D5	CHAR(6)	Time writer began processing spooled file
1499	5DB	CHAR(7)	Date writer completed processing spooled file
1506	5E2	CHAR(6)	Time writer completed processing spooled file
1512	5E8	CHAR(8)	Job system name
1520	5F0	CHAR(10)	Auxiliary storage pool device name
1530	5FA	CHAR(7)	Expiration date

SPLA0200 Format

The following table shows the information returned for the SPLA0200 format. For more details about the fields in the following table, see Field Descriptions.

Offset		Type	Field
Dec	Hex
0	0	BINARY(4)	Bytes returned
4	4	BINARY(4)	Bytes available
8	8	CHAR(8)	Format name
16	10	CHAR(16)	Internal job identifier
32	20	CHAR(16)	Internal spooled file identifier
48	30	CHAR(10)	Job name
58	3A	CHAR(10)	User name
68	44	CHAR(6)	Job number
74	4A	CHAR(10)	Spooled file name
84	54	BINARY(4)	Spooled file number
88	58	CHAR(10)	Form type
98	62	CHAR(10)	User-specified data
108	6C	CHAR(10)	Status
118	76	CHAR(10)	File available
128	80	CHAR(10)	Hold file before written
138	8A	CHAR(10)	Save file after written
148	94	BINARY(4)	Total pages
152	98	BINARY(4)	Page or record being written
156	9C	BINARY(4)	Starting page
160	A0	BINARY(4)	Ending page
164	A4	BINARY(4)	Last page printed
168	A8	BINARY(4)	Restart printing
172	AC	BINARY(4)	Total copies
176	B0	BINARY(4)	Copies left to produce
180	B4	BINARY(4)	Lines per inch
184	B8	BINARY(4)	Characters per inch
188	BC	CHAR(2)	Output priority
190	BE	CHAR(10)	Output queue name
200	C8	CHAR(10)	Output queue library name
210	D2	CHAR(7)	Date file opened (created)
217	D9	CHAR(6)	Time file opened (created)
223	DF	CHAR(10)	Device file name
233	E9	CHAR(10)	Device file library name
243	F3	CHAR(10)	Program that opened file name
253	FD	CHAR(10)	Program that opened file library name
263	107	CHAR(15)	Accounting code
278	116	CHAR(30)	Print text
308	134	BINARY(4)	Record length
312	138	BINARY(4)	Maximum records
316	13C	CHAR(10)	Device type
326	146	CHAR(10)	Printer device type
336	150	CHAR(12)	Document name
348	15C	CHAR(64)	Folder name
412	19C	CHAR(8)	System/36 procedure name
420	1A4	CHAR(10)	Print fidelity
430	1AE	CHAR(1)	Replace unprintable characters
431	1AF	CHAR(1)	Replacement character
432	1B0	BINARY(4)	Page length
436	1B4	BINARY(4)	Page width
440	1B8	BINARY(4)	Number of separators
444	1BC	BINARY(4)	Overflow line number
448	1C0	CHAR(10)	Multi-byte data
458	1CA	CHAR(10)	DBCS extension characters
468	1D4	CHAR(10)	DBCS shift-out shift-in (SO/SI) spacing
478	1DE	CHAR(10)	DBCS character rotation
488	1E8	BINARY(4)	DBCS characters per inch
492	1EC	CHAR(10)	Graphic character set
502	1F6	CHAR(10)	Code page
512	200	CHAR(10)	Form definition name
522	20A	CHAR(10)	Form definition library name
532	214	BINARY(4)	Source drawer
536	218	CHAR(10)	Printer font
546	222	CHAR(6)	System/36 spooled file identifier
552	228	BINARY(4)	Page rotation
556	22C	BINARY(4)	Justification
560	230	CHAR(10)	Print on both sides (duplex)
570	23A	CHAR(10)	Fold records
580	244	CHAR(10)	Control character
590	24E	CHAR(10)	Align forms
600	258	CHAR(10)	Print quality
610	262	CHAR(10)	Form feed
620	26C	CHAR(71)	Volumes (array)
691	2B3	CHAR(17)	File label identifier
708	2C4	CHAR(10)	Exchange type
718	2CE	CHAR(10)	Character code
728	2D8	BINARY(4)	Total records
732	2DC	BINARY(4)	Multiple up (pages per side)
736	2E0	CHAR(10)	Front overlay name
746	2EA	CHAR(10)	Front overlay library name
756	2F4	PACKED(15,5)	Front overlay offset down
764	2FC	PACKED(15,5)	Front overlay offset across
772	304	CHAR(10)	Back overlay name
782	30E	CHAR(10)	Back overlay library name
792	318	PACKED(15,5)	Back overlay offset down
800	320	PACKED(15,5)	Back overlay offset across
808	328	CHAR(10)	Unit of measure
818	332	CHAR(10)	Page definition name
828	33C	CHAR(10)	Page definition library name
838	346	CHAR(10)	Line spacing
848	350	PACKED(15,5)	Point size
856	358	BINARY(4)	Maximum spooled data record size
860	35C	BINARY(4)	Spooled file buffer size
864	360	CHAR(6)	Spooled file level
870	366	ARRAY(4)	Coded font array
886	376	CHAR(10)	Channel mode
896	380	ARRAY(12)	Channel value array
944	3B0	CHAR(8)	Graphics token
952	3B8	CHAR(10)	Record format
962	3C2	CHAR(2)	Reserved
964	3C4	PACKED(15,5)	Height of drawer 1
972	3CC	PACKED(15,5)	Width of drawer 1
980	3D4	PACKED(15,5)	Height of drawer 2
988	3DC	PACKED(15,5)	Width of drawer 2
996	3E4	BINARY(4)	Number of buffers
1000	3E8	BINARY(4)	Maximum forms width
1004	3EC	BINARY(4)	Alternate forms width
1008	3F0	BINARY(4)	Alternate forms length
1012	3F4	BINARY(4)	Alternate lines per inch
1016	3F8	CHAR(2)	System/38™ Text Utility flags
1018	3FA	CHAR(1)	File open
1019	3FB	CHAR(1)	Page count estimated
1020	3FC	CHAR(1)	File stopped on page boundary
1021	3FD	CHAR(1)	TRC for 1403
1022	3FE	CHAR(1)	Define characters
1023	3FF	CHAR(1)	Characters per inch changes
1024	400	CHAR(1)	Transparency
1025	401	CHAR(1)	Double-wide characters
1026	402	CHAR(1)	DBCS character rotation commands
1027	403	CHAR(1)	Extended code page
1028	404	CHAR(1)	FFT emphasis
1029	405	CHAR(1)	3812 SCS
1030	406	CHAR(1)	Set Line Density command
1031	407	CHAR(1)	Graphics error actions
1032	408	CHAR(1)	5219 commands
1033	409	CHAR(1)	3812 SCS commands
1034	40A	CHAR(1)	Field outlining
1035	40B	CHAR(1)	Final form text
1036	40C	CHAR(1)	Bar code
1037	40D	CHAR(1)	Color
1038	40E	CHAR(1)	Drawer change
1039	40F	CHAR(1)	Character ID
1040	410	CHAR(1)	Lines per inch changes
1041	411	CHAR(1)	Font
1042	412	CHAR(1)	Highlight
1043	413	CHAR(1)	Page rotate
1044	414	CHAR(1)	Subscript
1045	415	CHAR(1)	Superscript
1046	416	CHAR(1)	DDS
1047	417	CHAR(1)	Final form feed
1048	418	CHAR(1)	SCS data
1049	419	CHAR(1)	User-generated data stream
1050	41A	CHAR(1)	Graphics
1051	41B	CHAR(1)	Unrecognizable data
1052	41C	CHAR(1)	ASCII transparency
1053	41D	CHAR(1)	IPDS™ transparent data
1054	41E	CHAR(1)	OfficeVision®
1055	41F	CHAR(1)	Lines-per-inch (lpi) value not supported
1056	420	CHAR(1)	CPA3353 message
1057	421	CHAR(1)	Set exception
1058	422	CHAR(1)	Carriage control characters
1059	423	CHAR(1)	Page position
1060	424	CHAR(1)	Character not valid
1061	425	CHAR(1)	Lengths present
1062	426	CHAR(1)	5A present
1063	427	CHAR(1)	Reserved
1064	428	BINARY(4)	Number of font array entries
1068	42C	BINARY(4)	Number of resource library entries
1072	430	CHAR(1153)	Font equivalence array
2225	8B1	CHAR(631)	Resource library array
2856	B28	CHAR(1)	IBM® i-created AFPDS
2857	B29	CHAR(1)	Job character ID specified
2858	B2A	CHAR(1)	S36 CONTINUE-YES
2859	B2B	CHAR(10)	Decimal format
2869	B35	CHAR(7)	Date file last used
2876	B3C	CHAR(1)	Page groups
2877	B3D	CHAR(1)	Group level index tags
2878	B3E	CHAR(1)	Page level index tags
2879	B3F	CHAR(1)	IPDS pass-through
2880	B40	BINARY(4)	Offset to user resource library list
2884	B44	BINARY(4)	Number of user resource library list entries
2888	B48	BINARY(4)	Length of user resource library list entry
2892	B4C	CHAR(2)	Reserved
2894	B4E	CHAR(1)	Corner staple
2895	B4F	CHAR(1)	Edge-stitch reference edge
2896	B50	PACKED(15,5)	Offset from edge-stitch reference edge
2904	B58	BINARY(4)	Edge-stitch number of staples
2908	B5C	BINARY(4)	Offset to edge-stitch staple offset list
2912	B60	BINARY(4)	Number of edge-stitch staple offset entries
2916	B64	BINARY(4)	Length of edge-stitch staple offset entry
2920	B68	CHAR(10)	Font resolution for formatting
2930	B72	CHAR(1)	Record format name present in data stream
2931	B73	CHAR(1)	Saddle-stitch reference edge
2932	B74	BINARY(4)	Saddle-stitch number of staples
2936	B78	BINARY(4)	Offset to saddle-stitch staple offset list
2940	B7C	BINARY(4)	Number of saddle-stitch staple offset entries
2944	B80	BINARY(4)	Length of saddle-stitch staple offset entry
2948	B84	PACKED(15,0)	Data stream size
2956	B8C	BINARY(4)	Offset to library list
2960	B90	BINARY(4)	Number of library list entries
2964	B94	BINARY(4)	Length of library list entry
2968	B98	BINARY(4)	Offset to Internet Print Protocol spooled file attributes
2972	B9C	BINARY(4)	Offset to Save and Restore spooled file attributes
2976	BA0	BINARY(4)	CCSID of job
2980	BA4	CHAR(172)	Reserved
3152	C50	PACKED(15,5)	Front margin offset down
3160	C58	PACKED(15,5)	Front margin offset across
3168	C60	PACKED(15,5)	Back margin offset down
3176	C68	PACKED(15,5)	Back margin offset across
3184	C70	PACKED(15,5)	Length of page
3192	C78	PACKED(15,5)	Width of page
3200	C80	CHAR(10)	Measurement method
3210	C8A	CHAR(1)	Advanced Function Presentation (AFP) resource
3211	C8B	CHAR(10)	Character set name
3221	C95	CHAR(10)	Character set library name
3231	C9F	CHAR(10)	Code page name
3241	CA9	CHAR(10)	Code page library name
3251	CB3	CHAR(10)	Coded font name
3261	CBD	CHAR(10)	Coded font library name
3271	CC7	CHAR(10)	DBCS-coded font name
3281	CD1	CHAR(10)	DBCS-coded font library name
3291	CDB	CHAR(10)	User-defined file
3301	CE5	CHAR(10)	Reduce output
3311	CEF	CHAR(1)	Constant back overlay
3312	CF0	BINARY(4)	Output bin
3316	CF4	BINARY(4)	CCSID
3320	CF8	CHAR(100)	User-defined text
3420	D5C	CHAR(8)	System where file originated
3428	D64	CHAR(8)	Net ID where file originated
3436	D6C	CHAR(10)	User who owned file
3446	D76	CHAR(2)	Reserved
3448	D78	BINARY(4)	Offset to user-defined options
3452	D7C	BINARY(4)	Number of user-defined options returned
3456	D80	BINARY(4)	Length of each user-defined option entry
3460	D84	CHAR(255)	User-defined data
3715	E83	CHAR(10)	User-defined object name
3725	E8D	CHAR(10)	User-defined object library name
3735	E97	CHAR(10)	User object type
3745	EA1	CHAR(3)	Reserved
3748	EA4	PACKED(15,5)	Character set point size
3756	EAC	PACKED(15,5)	Coded font point size
3764	EB4	PACKED(15,5)	DBCS-coded font point size
3772	EBC	BINARY(4)	Auxiliary storage pool
3776	EC0	BINARY(4)	Spooled file size
3780	EC4	BINARY(4)	Spooled file size multiplier
3784	EC8	BINARY(4)	Internet print protocol job identifier
3788	ECC	CHAR(1)	Spooled file creation security method
3789	ECD	CHAR(1)	Spooled file creation authentication method
3790	ECE	CHAR(7)	Date writer began processing spooled file
3797	ED5	CHAR(6)	Time writer began processing spooled file
3803	EDB	CHAR(7)	Date writer completed processing spooled file
3810	EE2	CHAR(6)	Time writer completed processing spooled file
3816	EE8	CHAR(8)	Job system name
3824	EF0	CHAR(10)	Auxiliary storage pool device name
3834	EFA	CHAR(7)	Expiration date

User-Defined Option Entry

Each user-defined option entry has the following structure. For more details about the fields in the following table, see Field Descriptions.

Note: One entry is returned for each user-defined option. The number of entries may vary from one spooled file to another.

Offset		Type	Field
Dec	Hex
0	0	CHAR(10)	User-defined option

User Resource Library List Entry

Each user resource library list entry has the following structure. For more details about the fields in the following table, see Field Descriptions.

Note: One entry is returned for each user resource library. The number of entries may vary from one spooled file to another.

Offset		Type	Field
Dec	Hex
0	0	CHAR(10)	User resource library

Edge-Stitch Staple Offset Entry

Each edge-stitch staple offset entry has the structure stated in the following table. For more details about the fields in the following table, see Field Descriptions.

Note: One entry is returned for each edge-stitch staple. The number of entries may vary from one spooled file to another.

Offset		Type	Field
Dec	Hex
0	0	PACKED(15,5)	Edge-stitch staple offset

Saddle-Stitch Staple Offset Entry

Each saddle-stitch staple offset entry has the following structure. For more details about the fields in the following table, see Field Descriptions.

Note: One entry is returned for each saddle-stitch staple. The number of entries may vary from one spooled file to another.

Offset		Type	Field
Dec	Hex
0	0	PACKED(15,5)	Saddle-stitch staple offset

Library List Entry

Each library list entry has the following structure. For more details about the fields in the following table, see Field Descriptions.

Note: One entry is returned for each library. The number of entries may vary from one spooled file to another.

Offset		Type	Field
Dec	Hex
0	0	CHAR(10)	Library name

Internet Print Protocol Spooled File Attributes.

The Internet Print Protocol (IPP) specific spooled file attributes has the following structure. For more details about the fields in the following table, see Field Descriptions.

Note: These attributes are present only if the spooled file was created through IPP.

Offset		Type	Field
Dec	Hex
0	0	BINARY(4)	Length of IPP attributes
4	4	BINARY(4)	CCSID of the IPP attributes
8	8	CHAR(63)	Natural language of IPP attributes
71	47	CHAR(127)	IPP printer name
198	C6	CHAR(255)	IPP job name
453	1C5	CHAR(63)	IPP job name natural language
516	204	CHAR(255)	IPP job-originating user name
771	303	CHAR(63)	IPP job-originating user name natural language

Save and Restore Spooled File Attributes.

The Save and Restore specific spooled file attributes has the following structure. For more details about the fields in the following table, see Field Descriptions.

Note: These attributes are present only if the spooled file was saved or restored.

Offset		Type	Field
Dec	Hex
0	0	BINARY(4)	Length of save and restore attributes
4	4	BINARY(4)	Save sequence number
8	8	CHAR(13)	Spooled file saved date and time
21	15	CHAR(13)	Spooled file restore date and time
34	22	CHAR(71)	Save volume ID
105	69	CHAR(10)	Save command
115	73	CHAR(10)	Save device
125	7D	CHAR(10)	Save file name
135	87	CHAR(10)	Save file library name
145	91	CHAR(17)	Save label

Field Descriptions

Accounting code. An identifier assigned by the system to record the resources used to write this file.

Advanced Function Presentation (AFP) resource. Whether this spooled file refers to AFP resources external to this spooled file, for example, page segments or overlays.

The possible values are:

Y	The spooled file refers to AFP resources external to the spooled file.
N	The spooled file does not refer to AFP resources external to the spooled file.

Align forms. Whether a forms alignment message is sent prior to printing this file. The options are *YES or *NO.

Alternate forms length. The length of the alternate forms in lines. This field applies only to files created by the OfficeVision program and should be set to 0 by an application building this format as opposed to retrieving the fields.

Alternate forms width. The width of the alternate forms in character positions. This field applies only to files created by the OfficeVision program and should be set to 0 by an application building this format as opposed to retrieving the fields.

Alternate lines per inch. The lines per inch for the alternate forms. This field applies only to files created by the OfficeVision program and should be set to 0 by an application building this format as opposed to retrieving the fields.

ASCII transparency. For SCS files, whether ASCII commands are embedded in the ASCII transparency command. The ASCII transparency command is command_ID/command_length/ASCII_data. The command ID is a 1-byte field with value hex 03. The command length is a 1-byte field that contains the length of the command length field and the ASCII data field.

Valid values are Y (yes) or N (no).

Auxiliary storage pool. The number of the auxiliary storage pool (ASP) that the spooled file is stored on.

The possible values are:

1	System ASP.
2-255	One of the ASPs.

Auxiliary storage pool device name. The name of the auxiliary storage pool (ASP) device that the spooled file is stored on.

The possible values are:

*SYSBAS	The spooled file resides on the system ASP (ASP 1) or one of the defined basic user ASPs (ASPs 2-32).
auxiliary storage pool device name	The name of the auxiliary storage pool (ASP) device that the spooled file resides on.

Back margin offset across. For the back side of a piece of paper, it specifies, in either inches or centimeters (specified in the unit of measure (UOM) field), how far in from the left side of the page printing starts.

The possible values are:

0-57.79

The offset in inches or centimeters, according to the unit of measure value (see Unit of measure). The maximum offset is 57.79 centimeters or 22.75 inches.

Back margin offset down. For the back side of a piece of paper, it specifies, in either inches or centimeters (specified in the unit of measure (UOM) field), how far down from the top of the page printing starts.

The possible values are:

-1	*FRONTMGN. The back margin offsets are the same as the front margin offsets.
-2	*DEVD. For printers configured AFP(*YES), no print border is used for back margin offsets across and down. Otherwise, the offset values are 0.
0-57.79	The offset in inches or centimeters, according to the unit of measure value (see Unit of measure). The maximum offset is 57.79 centimeters or 22.75 inches.

Back overlay library name. The name of the library containing the back overlay.

The possible values are:

*CURLIB	The current library for the job locates the back overlay.
*LIBL	The library list locates the back overlay.
library name	This library is searched for the back overlay.

Back overlay name. The name of the back overlay (the material that prints on the back side of each page).

The possible values are:

*FRONTOVL	The back overlay is the same as the front overlay.
*NONE	The file does not use a back overlay.
back overlay name	The name of the back overlay.

Back overlay offset across. The offset across from the point of origin where the overlay is printed.

The possible values are:

0-57.79

The offset in inches or centimeters, according to the unit of measure value (see Unit of measure). The maximum offset is 57.79 centimeters or 22.75 inches.

Back overlay offset down. The offset down from the point of origin where the overlay is printed.

The possible values are:

0-57.79

The offset in inches or centimeters, according to the unit of measure value (see Unit of measure). The maximum offset is 57.79 centimeters or 22.75 inches.

Bar code. Whether the spooled file contains bar codes created using the BARCODE keyword in the data description specifications (DDS).

For DEVTYPE(*IPDS and *AFPDS), a series of bar code commands is contained in the data stream.

Valid values are Y (yes) or N (no).

Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.

Bytes returned. The number of bytes of data returned.

Carriage control characters. Whether the file has machine carriage control characters.

Valid values are Y (yes) or N (no).

CCSID. The coded character set identifier (CCSID) used when the user-defined text was created using the Change User Print Information (CHGUSRPRTI) command.

CCSID of IPP attributes. The coded character set identifier (CCSID) used when the IPP attributes were set for the spooled file. The spooled file attributes affected are:

• IPP printer name
• IPP job name
• IPP job-originating user name

CCSID of job. The coded character set identifier (CCSID) of the job when the spooled file was created. This CCSID may or may not represent the contents of the spooled file.

The possible values are:

0	The CCSID is unknown. The CCSID of the job that generated the contents of this spooled file was not saved when the spooled file was created.
1-65535	The coded character set identifier.

Channel value array. Contains the skip-to line number associated with the channel value. (The first entry in the array applies to channel 1.) The variable returns a maximum of 12 binary(4) values. Each of the values returned is 0 if the mode is *NORMAL.

Channel mode. A variable indicating the channel value mode.

The possible values are:

*NORMAL	The normal channel values (1 equals skip to line 1, 2 through B equal space one line before printing, C equals Skip to overflow line).
blank	The channel values specified in the channel code array are used.

Character code. Whether the coding for the diskette file is in ASCII or EBCDIC form.

Character ID. Whether the character ID can change within the file.

• For DEVTYPE(*SCS), a Set CGCS through Local ID is contained in the spooled file.
• For DEVTYPE(*IPDS), a Load Font Equivalence command is inserted into the Load Font Equivalence table.
• For DEVTYPE(*AFPDS), a map code font-2 (MCF-2) structured field is contained in the spooled file.

Valid values are Y (yes) or N (no).

Character not valid. Whether incorrect character errors are reported.

Valid values are Y (yes) or N (no).

Character set library name. The name of the library containing the font character set object.

The possible values are:

*CURLIB	The current library is searched for the font character set object.
*LIBL	The library list is used to locate the font character set object.
library name	This library is searched for the font character set object.

Character set name. The name of the font character set object used to print this file.

The possible values are:

*FONT	The information specified on the font parameter is used instead of the character set and code page.
character set name	The name of the font character set object to use.

Character set point size. The point size in which this file's characters (defined by the character set field) should be printed.

The possible values are:

000.0	*NONE. The character set does not have a point size.
000.1-999.9	The point size of the character set.

Characters per inch. The number (in tenths) of characters per horizontal inch, defined in the printer file. The value 100 indicates 10 characters per inch.

Characters per inch changes. Whether the spooled file changes the characters per inch (cpi) within the file.

For DEVTYPE(*SCS), a Set Character Distance command is contained in the spooled file.

Valid values are Y (yes) or N (no).

Code page. The mapping of graphic characters to code points for this printer. For *DEVD, the operating system sends a device default character set value to the printer, which determines the character set to be used.

Code page library name. The name of the library containing the code page used to print this spooled file.

The possible values are:

*CURLIB	The current library is searched for the code page name.
*LIBL	The library list is used to locate the code page.
library name	This library is searched for the code page name.

Code page name. The name of the code page used to print this spooled file.

Code pages are groups of characters. Within a code page unique hexadecimal identifiers are assigned to each of the characters.

Coded font array. The name of the fonts used for printing a line data file. This corresponds to the CHARS parameter of MVS™ and VM printing services. The variable returns a maximum of 4 four-character-coded fonts. The variable is returned blank if no coded fonts are specified. The name specified does not include the two-character prefix of the coded font name (X0 through XG). For more information about the CHARS fields, see the Print Services Facility™/MVS Application Programming Guide or Print Services Facility User's Programmers Guide for VM.

Coded font library name. The name of the library containing the coded font used to print this spooled file.

The possible values are:

*CURLIB	The current library is searched for the coded font.
*LIBL	The library list is used to locate the coded font.
library name	This library is searched for the coded font.

Coded font name. The name of the coded font used to print this spooled file. A coded font is an AFP resource composed of a character set and a code page.

The possible values are:

*FNTCHRSET	The values used are the values specified on the character set name and library name and code page name and library name fields.
coded font name	The name of the coded font used to print this spooled file.

Coded font point size. The point size in which this file's characters (defined by the coded font field) should be printed.

The possible values are:

000.0	*NONE. The coded font does not have a point size.
000.1-999.9	The point size of the coded font.

Color. Whether an IPDS Write Text command or AFPDS presentation text data (PTX) structured field containing a Set Text Color text control is contained in the spooled file.

For DEVTYPE(*IPDS and *AFPDS), a Set Text Color text control is contained in the spooled file.

Valid values are Y (yes) or N (no).

Constant back overlay. Whether or not constant back overlay is used. Constant back allows the user to print overlays on the back side of each sheet of media without the need for the print application to generate blank pages. The constant back function causes blank pages to be generated by the operating system onto which the back overaly will be printed. The generated blank pages are called constant forms because no variable data from the user's print application is printed on the pages. Constant back overlay is ignored if the print on both sides field is set to *NO.

The possible values are:

0	*NOCONSTANT. Constant back overlay is not used.
1	*CONSTANT. Constant back overlay is used.

Control character. Whether this printer file uses the American National Standard printer control character.

The possible values are:

*NONE	No print control characters are passed in the data that is printed.
*FCFC	The first character of every record is an American National Standard printer control character.

Copies left to produce. The remaining number of copies to be produced on the printer. Valid values are 1 through 255.

CPA3353 message. Whether message CPA3353 is issued when this file is printed.

Valid values are Y (yes) or N (no).

Corner staple. The reference corner to be used for a corner staple. A staple is driven into the media at the reference corner. Refer to your printer's documentation for information as to which reference corners are supported.

Valid values are:

0	*NONE. A corner staple is not specified.
1	*DEVD. The default reference corner of the printer device is specified.
2	*BOTRIGHT. The bottom right-hand corner of the paper is specified.
3	*TOPRIGHT. The top right-hand corner of the paper is specified.
4	*TOPLEFT. The top left-hand corner of the paper is specified.
5	*BOTLEFT. The bottom left-hand corner of the paper is specified.

Data stream size. The number of bytes of data stream for the file. If the file is still open when the fields are retrieved, the data stream size is the number of bytes of data stream written to the file thus far. If the number of bytes of data stream is zero, possible reasons are there was a problem retrieving the number of data stream bytes or there have not been any bytes of data stream written to the spooled file yet.

Date file last used. The date, based on local job time, that the file data was last displayed, copied, printed, or sent; or when the file attributes were last changed. The date is in the CYYMMDD format as follows:

C	Century, where 0 indicates years 19xx and 1 indicates years 20xx.
YY	Year
MM	Month
DD	Day

Date file opened (created). The date, based on local job time, that the file was opened in the CYYMMDD format where:

C	Century, where 0 indicates years 19xx and 1 indicates years 20xx.
YY	Year
MM	Month
DD	Day

Date writer began processing spooled file. The date, based on local job time, that a spooling writer started processing the spooled file. This field is set to blanks if the file has not been processed by a writer. The date is in the CYYMMDD format as follows:

C	Century, where 0 indicates years 19xx and 1 indicates years 20xx.
YY	Year
MM	Month
DD	Day

Date writer completed processing spooled file. The date, based on local job time, that a spooling writer completed processing the spooled file or the date the processing of the spooled file was aborted. This field is set to blanks if the file has not been processed by a writer or the writer has not completed processing the file. The date is in the CYYMMDD format as follows:

C	Century, where 0 indicates years 19xx and 1 indicates years 20xx.
YY	Year
MM	Month
DD	Day

DBCS character rotation. Whether this printer file causes the double-byte character set (DBCS) characters to be rotated 90 degrees counterclockwise before printing. The possible values are *YES and *NO.

DBCS character rotation commands. Whether the double byte character set characters are rotated 90 degrees counterclockwise before printing.

• For DEVTYPE(*SCS), a Set Text Orientation command is contained in the spooled file.
• For DEVTYPE(*AFPDS), a map coded font-1 (MCF-1) structured field, that has the character rotation parameter set to hex 8700 in the spooled file.

Valid values are Y (yes) or N (no).

DBCS characters per inch. The number of double-byte characters to be printed per inch.

The possible values are:

-1	*CPI One-half of the characters per inch value.
-2	*CONDENSED 20 double-byte characters per 3 inches.
5	5 characters per inch.
6	6 characters per inch.
10	10 characters per inch.

DBCS-coded font library name. The name of the library containing the DBCS-coded font.

The possible values are:

*CURLIB	The current library is searched for the DBCS-coded font.
*LIBL	The library list is used to locate the DBCS-coded font.
library name	This library is searched for the DBCS-coded font.

DBCS-coded font name. The name of the DBCS-coded font used to print DBCS-coded data on printers configured as AFP(*YES).

The possible values are:

*SYSVAL	The DBCS-coded font specified in the system value is used.
DBCS-coded font name	The name of the DBCS-coded font being used.

DBCS-coded font point size. The point size in which this file's DCBS characters (defined by the DBCS-coded font field) should be printed.

The possible values are:

000.0	*NONE. The DBCS-coded font does not have a point size.
000.1-999.9	The point size of the DBCS-coded font.

DBCS extension characters. Whether the system uses the extension character processing function for DBCS data.

The possible values are:

*YES	The system processes DBCS extension characters.
*NO	The system does not process DBCS extension characters; it prints extension characters as the undefined character.

DBCS shift-out shift-in (SO/SI) spacing. The presentation of shift-out and shift-in characters when printed.

The possible values are:

*YES	Shift-out and shift-in characters occupy one space.
*NO	Shift-out and shift-in characters occupy no space.
*RIGHT	Shift-out characters occupy no space; shift-in characters occupy 2 spaces.

DDS. Whether the file was constructed with DDS.

Valid values are Y (yes) or N (no).

Decimal format. Whether the decimal format from the DECFMT job attribute or from the printer file was used when the spooled file was created.

*FILE	The decimal format used was from the printer file.
*JOB	The decimal format used was from the DECFMT job attribute.

Define characters. Whether the spooled file defines or redefines unique print characters.

For DEVTYPE(*SCS), a Load Alternate Characters command is contained in the spooled file.

Valid values are Y (yes) or N (no).

Device file library name. The name of the library that contains the device file.

Device file name. The name of the device file used to create the spooled file.

Device type. The type of device file for which this file is intended. The possible values are PRINTER, DISKETTE, or TAPE.

Document name. The name of the document that was the source of the spooled file.

Double-wide characters. Whether the spooled file prints everything twice as wide as normal.

For DEVTYPE(*SCS), a Set Font Size command is contained in the data stream.

Valid values are Y (yes) or N (no).

Drawer change. Whether the printer drawer is changed within the spooled file.

• For DEVTYPE(*SCS), a Page Presentation Media command is contained in the spooled file.
• For DEVTYPE(*IPDS), an Execute Order Home State - Select Input Media Source is in the spooled file.
• For DEVTYPE(*AFPDS), a media map and an invoke media map are in the spooled file.

Valid values are Y (yes) or N (no).

Edge-stitch number of staples. The number of staples in the edge-stitch.

The valid values are:

0

*DEVD. Use the device default. This value is used if either of the following was specified: The offset of each staple is specified in the edge-stitch staple offset list. The printer will automatically determine the number of staples to be used. Zero (*DEVD) was specified for the number of edge-stitch staple offset entries field. The printer will use its default value for both the number of staples to be used as well as the offset of each staple.

1-122

Number of staples to be used in the edge-stitch.

Edge-stitch reference edge. The edge of the paper to be used as a reference in determining where the edge stitching is to be located.

Valid values are:

0	*NONE. No edge stitching is specified.
1	*DEVD. The default reference edge used by the printer device is specified.
2	*BOT. The bottom edge of the paper is specified.
3	*RIGHT. The right-hand edge of the paper is specified.
4	*TOP. The top edge of the paper is specified.
5	*LEFT. The left-hand edge of the paper is specified.

Edge-stitch staple offset. For the spooled file, the placement of staples along the finishing margin in either inches or centimeters (specified in the Unit of measure (UOM) field). The finishing margin can be thought of as an imaginary line parallel to the edge of the paper where the staples will be placed. The position of the finishing margin relative to the physical edge is specified in the offset from edge-stitch reference edge field.

If you want the staples placed along the left or right edge of the paper, specify the offset of the first staple by measuring from the point where the finishing margin intersects the bottom edge of paper to where you want the center of the staple to be. For subsequent staples, specify the offset by measuring from the same point (not from the previous staple).

If you want the staples placed along the top or bottom edge of the paper, specify the offset of the first staple by measuring from the point where the finishing margin intersects the left edge of paper to where you want the center of the staple to be. For subsequent staples, specify the offset by measuring from the same point (not from the previous staple).

The possible values are:

0-57.79

The offset in inches or centimeters, according to the unit of measure value (see Unit of measure). The maximum offset is 57.79 centimeters or 22.75 inches.

Ending page. The page at which printing is to end for the file. 0 or 2147483647 indicates the last page.

Exchange type. The exchange type of the diskette file.

The possible values are:

*STD	The system allows the exchange type based on the diskette type and sector size.
*BASIC	The basic exchange type.
*H	The H exchange type.
*I	The I exchange type.

Expiration date. The date the file will be eligible for removal from the system by the Delete Expired Spooled Files (DLTEXPSPLF) command and blank if the file will not expire. The spooled file will expire at 23:59:59, local system time on the date specified. The date is in the CYYMMDD format as follows:

C	Century, where 0 indicates years 19xx and 1 indicates years 20xx.
YY	Year
MM	Month
DD	Day

Extended code page. Whether the extended code page changes within the file.

• For DEVTYPE(*SCS), a Set CGCS through GCID is contained in the spooled file.
• For DEVTYPE(*IPDS), a Load Font Equivalence command is inserted into the Load Font Equivalence table.
• For DEVTYPE(*AFPDS), a map code font-2 (MCF-2) structured field is contained in the spooled file.

Valid values are Y (yes) or N (no).

FFT emphasis. Whether the spooled file contains text that is to appear darker than the surrounding text.

For DEVTYPE(*SCS), Begin Emphasis and End Emphasis commands are contained in the spooled file.

Valid values are Y (yes) or N (no).

Field outlining. Whether the spooled file outlines fields of data with boxes. If it does, the file must be printed on a printer that supports field outlining.

For DEVTYPE(*SCS), a Define Grid Line command is contained in the spooled file.

Valid values are Y (yes) or N (no).

File available. The time when this file becomes available to an output device for processing.

The possible values are:

*IMMED	The file is available as soon as the file is opened.
*FILEEND	The file is available as soon as the file is closed.
*JOBEND	The file is available when the job that owns the file is completed.

File label identifier. The diskette label used when the system last saved the object.

File open. Whether the file is still open when fields are retrieved.

Valid values are Y (yes) or N (no).

File stopped on page boundary. Whether the file has stopped printing on a page boundary.

Valid values are Y (yes) or N (no).

Final form feed. Whether the Final Form Feed command is in the printer file.

Valid values are Y (yes) or N (no).

Final form text. Whether this spooled file contains various functions that are supported on letter-quality printers.

• For DEVTYPE(*SCS), a Document Content Architecture (DCA) command, is contained in the spooled file. DCA commands include:
  • Required New line
  • Required Form Feed
  • Indent Tab
  • Set Presentation Page Size
  • Set Horizontal Margins
  • Set Vertical Margins
  • Release Left Margin
  • Set Line Spacing
  • Set Single Line Distance
  • Justify Text Field Format
  • Set Justify Mode
  • Set Horizontal Tab Stops
  • Set Indent Level
  • Set Exception Action
  • Set Presentation Color
  • Set Spacing Variable
  • Begin and End Overstrike
  • Begin and End Underscore
  • Bell
  • Switch
  • Repeat
  • Tab
  • Backspace
  • Unit Backspace
  • Substitute
  • Word Underscore

Valid values are Y (yes) or N (no).

Fold records. Whether records exceeding the printer forms width are folded (wrapped) to the next line. The possible values are *YES or *NO.

Folder name. The name of the folder that contains the source document.

Font. Whether the spooled file uses multiple fonts.

• For DEVTYPE(*SCS), a Set Font Global command is in the spooled file.
• For DEVTYPE(*IPDS), a Load Font Equivalence command is contained in the Load Font Equivalence table.
• For DEVTYPE(*AFPDS), a map coded font-1 (MCF-1) or map coded font-2 (MCF-2) structured field is in the spooled file.

Valid values are Y (yes) or N (no).

Font equivalence array. The data portion of the Load Font Equivalence (LFE) command for intelligent printer data streams (IPDSs). The variable returns a maximum of 72 sixteen-character font equivalence entries. The current maximum is 48. The additional array space is provided for further expansion. If more than 72 font equivalence entries are used, a 1 is returned in the 1153rd character of the variable; otherwise, the 1153rd character is blank. The format of this entry is described in the IPDS Reference manual, S544-3417. This manual is available from the IBM^® Publications Center.

Font resolution for formatting. The resolution Print Services Facility/400 (PSF/400) should use to print the spooled file when printing to a multiple resolution printer and either of the following conditions exist:

• The information is not specified in the spooled file data stream.
• The font used in the spooled file could not be found.

The possible values are:

*DEVD	PSF/400 is to use the value specified on the font resolution for formatting parameter in the PSF configuration object. The PSF configuration object is specified in the printer device description.
*SEARCH	PSF is to search for a font that will work. The search method is outlined in the Printer Device Programming manual.
240	PSF/400 is to use only fonts that are 240 pels per inch.
300	PSF/400 is to use only fonts that are 300 pels per inch.

Form definition library name. The name of the library that contains the form definition.

Form definition name. The name of the form definition to use for this print request or one of the following special values:

*DEVD	The form definition in the printer device description will be used.
*INLINE	The form definition defined in the spooled file data stream will be used.
*INLINED	The form definition defined in the spooled file data stream will be used. If a form definition is not found, the form definition in the printer device description will be used.
F1DFLT	The form definition defined in the spooled file data stream will be used. F1DFLT is the in-line form definition built by IBM i for spooled files of printer device type *AFPDS. When the field IBM i created AFPDS is set to 'Y', the form definition library name field is set to blanks.

Form feed. The manner in which forms feed to the printer.

The possible values are:

*CONT	Continuous forms
*CUT	Manually fed cut forms
*AUTOCUT	Automatically fed cut forms
*DEVD	As defined in the device description
*CONT2	Secondary continuous forms

Form type. The type of form to be loaded in the printer to print this file.

Format name. The name of the format used to return information.

Front margin offset across. For the front side of a piece of paper, it specifies, in either inches or centimeters (specified in the unit of measure (UOM) field), how far in from the left side of the page printing starts.

The possible values are:

0-57.79

The offset in inches or centimeters, according to the unit of measure value (see Unit of measure). The maximum offset is 57.79 centimeters or 22.75 inches.

Front margin offset down. For the front side of a piece of paper, it specifies, in either inches or centimeters (specified in the unit of measure (UOM) field), how far down from the top of the page printing starts.

The possible values are:

-2	*DEVD. For printers configured AFP(*YES), no print border is used for front margin offsets across and down. Otherwise, the offset values are 0.
0-57.79	The offset in inches or centimeters, according to the unit of measure value (see Unit of measure). The maximum offset is 57.79 centimeters or 22.75 inches.

Front overlay library name. The name of the library containing the front overlay.

The possible values are:

*CURLIB	The current library for the job locates the front overlay.
*LIBL	The library list locates the front overlay.
library name	This library is searched for the front overlay.

Front overlay name. The name of the front overlay (the material that prints on the front side of each page).

The possible values are:

*NONE	The file does not use the front overlay.
front overlay name	The name of the front overlay.

Front overlay offset across. The offset across from the point of origin where the overlay is printed.

The possible values are:

0-57.79

The offset in inches or centimeters, according to the Unit of measure value. The maximum offset is 57.79 centimeters or 22.75 inches.

Front overlay offset down. The offset down from the point of origin where the overlay is printed.

The possible values are:

0-57.79

The offset in inches or centimeters, according to the Unit of measure value. The maximum offset is 57.79 centimeters or 22.75 inches.

Graphic character set. The set of graphic characters to be used when printing this file. For *DEVD, the system gets the graphic character set from the printer device description.

Graphics. Whether the spooled file contains graphics.

Valid values are Y (yes) or N (no).

Graphics error actions. Whether the file contains graphic error action commands.

For SCS files, the file contains one or more Set Graphic Error Action commands.

Valid values are Y (yes) or N (no).

Graphics token. The printer type on which the graphics in this file can be printed.

The possible values are:

4214	Data stream contains graphics for a 4214 printer.
4234	Data stream contains graphics for a 4234 SCS printer.
522X	Data stream contains graphics for a 522X printer.
IPDS	Data stream contains graphics for an IPDS printer.

Group level index tags. Whether the spooled file contains group level index tags as indicated by the DDS keyword DOCIDXTAG with a tag level of GROUP. The possible values are Y (yes) or N (no).

Height of drawer 1. The height in inches of the paper in drawer 1. This field is for internal use and should be set to 0 by an application building this format as opposed to retrieving the fields.

Height of drawer 2. The height in inches of the paper in drawer 2. This field is for internal use and should be set to 0 by an application building this format as opposed to retrieving the fields.

Highlight. Whether the spooled file contains text that is to appear darker than the surrounding text.

• For DEVTYPE(*SCS), data is overprinted to get the bold effect.
• For DEVTYPE(*IPDS), a Load Font Equivalence command is contained in the Load Font Equivalence table, which has the bold field set on.
• For DEVTYPE(*AFPDS), a map coded font-2 (MCF-2) structured field that has the font weight class parameter set to hex 07 is in the spooled file.

Valid values are Y (yes) or N (no).

Hold file before written. Whether the file is held. The hold parameter handles this function on a Create Printer File (CRTPRTF), Override Printer File (OVRPRTF), or Change Printer File (CHGPRTF) command.

The possible values are:

*YES	The file is held.
*NO	The file is not held.

Internal job identifier. The internal identifier for the job. Only the IBM i APIs use this identifier, not any other interface on the system. The identifier is not valid following an initial program load (IPL). If you attempt to use it after an IPL, an exception occurs.This identifier is always valid when used with the internal spooled file identifier as input to IBM i APIs. For spooled files which have been detached from their jobs or which are on independent disk pools, this value is not valid as input to some IBM i APIs, such as the Retrieve Job Information (QUSRJOBI) API, that take this value without the internal spooled file identifier.

Internal spooled file identifier. The value used as input to other programs to improve the performance of locating the spooled file on the system. Only the IBM i APIs use this identifier, not any other interface on the system. The identifier is not valid following an initial program load (IPL) or if the spooled file has been moved between auxiliary storage pools (ASPs). If you attempt to use an invalid internal spooled file identifier, an exception occurs.

Internet print protocol job identifier. The IPP job identifier assigned by the system based on the output queue to which the file was added or moved. This value ranges from 1 to 2147483647 and is not guaranteed to be unique for a given output queue.

IPDS pass-through. Whether IPDS pass-through is done for the spooled file. Not all SCS or IPDS spooled files are eligible for IPDS pass-through. They may contain special functions that require transform to AFPDS for correct printing. IPDS pass-through allows only those spooled files eligible for IPDS pass-through to bypass the extra transforms. Those spooled files not eligible for IPDS pass-through will still undergo the transforms to AFPDS and back to IPDS. IPDS pass-through will not be valid for all PSF/400 supported printers. Any printer (or attachment) that does not support resident fonts cannot support IPDS pass-through. This is because the resident font references in the data stream must be mapped to host fonts that are downloaded to the printer. All IBM IPDS printers, execpt for the following, can be supported with IPDS pass-through: 3820, 3825, 3827, 3828, 3829, 3831, 3835, 3900-001 and any printer attached using Print Services Facility for the OS/2^® distributed print function.

0	*DEVD. The value specified for IPDS pass-through (IPDSPASTHR) parameter in the PSF configuration object is used. The PSF configuration object is specified in the printer device description.
1	*NO.No IPDS pass-through is done.
2	*YES. IPDS pass-through is to be done if the spooled file is eligible for IPDS pass-through.

IPDS transparent data. Whether the file contains data from System/36 PRPQs.

Valid values are Y (yes) or N (no).

IPP job name. The IPP job name associated with the creation of the spooled file. This attribute is in the CCSID identified by the CCSID of IPP attributes field.

IPP job name natural language. The natural language in which the IPP job name was encoded. This attribute is in the CCSID specified by the CCSID of IPP attributes field. The possible values returned are defined in RFC 1766.

IPP job-originating user name. The name of the user that submitted the IPP job request that created the spooled file. This attribute is in the CCSID identified by the CCSID of IPP attributes field.

IPP job-originating user name natural language. The natural language in which the IPP job-originating user name was encoded. This attribute is in the CCSID specified by the CCSID of IPP attributes field. The possible values returned are defined in RFC 1766.

IPP printer name. The name of the IPP printer that created the spooled file. This attribute is in the CCSID specified in the CCSID of IPP attributes field.

Job character ID specified. Whether the graphic character set and code page of the spooled file is taken from the coded character set identifier (CCSID) of the job.

Valid values are Y (yes) or N (no).

Job name. The name of the job that owns the spooled file.

Job number. The number of the job that owns the spooled file.

Job system name. The name of the system where the job that created this spooled file ran.

Justification. The percentage that the output is right-justified. The possible values are 100, 50, or 0.

Last page printed. The number of the last printed page in the file if printing ended before the job completed processing.

Length of each user-defined option entry. The length, in bytes, of each user-defined option entry.

Length of IPP attributes. The length, in bytes, of the IPP specific spooled file attributes.

Length of page. The length of a page. Units of measurement are specified in the measurement method field.

Length of edge-stitch staple offset entry. The length, in bytes, of each edge-stitch staple offset entry.

Length of library list entry. The length, in bytes, of each library list entry.

Length of saddle-stitch staple offset entry. The length, in bytes, of each saddle-stitch staple offset entry.

Length of save and restore attributes. The length, in bytes, of the save and restore specific spooled file attributes.

Length of user resource library list entry. The length, in bytes, of each user resource library list entry.

Lengths present. Whether the 8-byte length information is present in the print text data buffers for format SPLF0200.

Valid values are Y (yes) or N (no).

Library name. The name of a library.

Line spacing. How a file's line data records are spaced when printed. This information is returned only for *LINE and *AFPDSLINE printer device type files.

The possible values are:

*SINGLE	Single-spaced
*DOUBLE	Double-spaced
*TRIPLE	Triple-spaced
*CTLCHAR	The control character field determines line spacing. The control character field can have one of these values: *NONE No print control characters are passed in the data that is printed. *FCFC The first character of every record is an American National Standards printer control character.

Lines per inch. The number (in tenths) of lines per vertical inch defined in the printer file. A value of 40 indicates 4 lines per inch.

Lines per inch changes. Whether the lines per inch (lpi) changes within the spooled file.

• For DEVTYPE(*SCS), a Set Single Line Density command is contained in the spooled file.
• For DEVTYPE(*IPDS), a Load Page Descriptor is contained in the spooled file, which specifies the line-per-inch value
• For DEVTYPE(*AFPDS), a presentation text description (PTD) structured field that specifies how the baseline LPI value changes, is contained in the spooled file.

Valid values are Y (yes) or N (no).

Lines-per-inch (lpi) value not supported. The lines-per-inch (lpi) value is represented in a 1440th-inch value and is not equivalent to 4, 6, 8, 9, or 12. This field applies only to OfficeVision files. It is N for all other spooled files.

Valid values are Y (yes) or N (no).

Maximum forms width. The maximum forms width (in positions) as specified on the printer file.

Maximum records. The maximum number of records allowed in the file at the time the file was opened. A value of 0 indicates no maximum.

Maximum spooled data record size. The length of the largest record in the file. For LINE, AFPDSLINE, and AFPDS files, this length is the length of the largest record in the file. For all other file types, this length is the same as the spooled file buffer size.

Measurement method. The measurement method used for the length of page and width of page fields.

The possible values are:

*ROWCOL	Uses rows and columns as the units of measure.
*UOM	Uses the value specified on the unit of measurement parameter (UOM). UOM is either inches (*INCH) or centimeters (*CM).

Multi-byte data. Whether the file can contain double-byte character set (DBCS) data, Unicode data, or both. The options are *YES or *NO.

Multiple up (pages per side). The number of logical pages that print on each side of each physical page when this file is printed. The possible values are 1, 2, 3, and 4.

Natural language of IPP attributes. The natural language in which the IPP attributes were encoded. This attribute is in the CCSID specified in the CCSID of IPP attributes field. The possible values returned are defined in RFC 1766. The spooled file attribute affected is:

• IPP Printer name

Net ID where file originated. The network ID of the system where the spooled file data stream was originally generated for this spooled file.

Number of buffers. The number of buffers currently in the file. If the file is still open when the fields are retrieved, the number of buffers is the number of buffers written to the file thus far.

Number of edge-stitch staple offset entries. The number of edge-stitch staple offset entries returned in this format. Only complete entries are returned. Each edge-stitch staple offset entry represents one staple in the edge-stitch.

The valid values are:

0	*DEVD. Use the device default. This value is used if either of the following is specified: The number of staples for the edge-stitch number of staples field was specified. The device default for the spacing of each staple will be used. Zero (*DEVD) was specified for the edge-stitch number of staples field. The device default for the spacing of each staple is used.
1-122	Number of edge-stitch staple offset entries.

Number of font array entries. The number of font equivalence array entries used. (The maximum number of font equivalence entries is currently 48.)

Number of library list entries. The number of entries in the library list.

Number of resource library entries. The number of entries in the resource library array used.

Number of saddle-stitch staple offset entries. The number of saddle-stitch staple offset entries returned in this format. Only complete entries are returned. Each saddle-stitch staple offset entry represents one staple in the saddle-stitch.

The valid values are:

0	*DEVD. Use the device default. This value is used if either of the following is specified: The number of staples for the saddle-stitch number of staples field was specified. The device default for the spacing of each staple will be used. Zero (*DEVD) was specified for the saddle-stitch number of staples field. The device default for the spacing of each staple is used.
1-122	Number of saddle-stitch staple offset entries.

Number of separators. The number of file separator pages placed at the beginning of each copy of this file.

Number of user-defined options returned. The number of user-defined option entries returned in this format. Only complete entries are returned.

Number of user resource library list entries. The number of user resource library list entries returned in this format. Only complete entries are returned.

The valid values are:

-1	*DEVD. The user resource library list in the PSF configuration object is to be used to search for AFPDS resources. The PSF configuration object is specified in the printer device description. If there is no PSF configuraton object, the spooled file's library list will be used to search for AFP resources.
-2	*JOBLIBL. The spooled file's library list will be used to search for AFP resources.
-3	*CURLIB. The current library for the job that created the spool file is used to search for AFP resources. If no library is specified as the current library for the job, then library QGPL is used.
0	*NONE.There is no user resource library list to be used to search for AFP resources.
1-4	The number of user resource libraries.

OfficeVision. Whether the spooled file is generated by the OfficeVision licensed program.

Valid values are Y (yes) or N (no).

Offset from edge-stitch reference edge. Specifies, in either inches or centimeters (specified in the Unit of measure (UOM) field), how far from the edge-stitch reference edge that the edge-stitch is to be placed.

The possible values are:

-1.0	*DEVD. The default edge-stitch offset of the printer device is specified.
0-57.79	The offset in inches or centimeters, according to the unit of measure value (see Unit of measure). The maximum offset is 57.79 centimeters or 22.75 inches.

Offset to edge-stitch staple offset list. The offset to the information about each staple offset entry. Each entry contains the staple offset for that staple.

Offset to IPP attributes. The offset to the IPP specific spooled file attributes. This value is set to 0 if the spooled file was not create through IPP.

Offset to library list. The offset to the list of libraries for the job at the time the spooled file was created. Each entry contains the name of a library.

Offset to saddle-stitch staple offset list. The offset to the information about each staple offset entry. Each entry contains the staple offset for that staple.

Offset to Save and Restore spooled file attributes. The offset to the save and restore specific spooled file attributes. This value is set to 0 if the spooled file was not saved or restored.

Offset to user-defined options. The offset to information about each user-defined option entry. Each entry contains the user-defined option.

Offset to user resource library list. The offset to the information about each user resource library list entry. Each entry contains the user resource library. When the offset is set to 0, there are no user resource libraries.

IBM i-created AFPDS. Whether the spooled file was created on a System i™ platform with a printer file that has the device type (DEVTYPE) parameter set to *AFPDS.

Output bin. The output bin that the printer uses for the printed output.

The possible values are:

0	*DEVD: The default output bin of the printer is used.
Output bin	The number of the output bin specified. The number must be between 1 and 65535.

Output priority. The priority of the output file. The priority ranges from 1 (highest) to 9 (lowest).

Output queue library name. The name of the library that contains the output queue.

Output queue name. The name of the output queue where the file is located.

Overflow line number. The last line to be printed before the data being printed overflows to the next page.

Page count estimated. Whether the total number of pages is actual or an estimated count.

Valid values are Y (yes) or N (no).

The total page count is estimated in the following situations:

• If the spooled file device type is *AFPDSLINE.
• If the spooled file device type is *LINE and a page definition was used.
  
• If the spooled file device type is *AFPDS and the spooled file was not created on a System i platform.
• If the spooled file device type is *USERASCII.

Page definition library name. The name of the library in which the page definition resides. This information is returned only for *LINE or *AFPDSLINE printer device type files.

Page definition name. The name of the page definition to use for the file. This information is returned only for *LINE or *AFPDSLINE printer device type files.

Page groups. Whether the spooled file contains page groups as indicated by the DDS keywords STRPAGGRP and ENDPAGGRP. The possible values are Y (yes) or N (no).

Page length. The page length (in lines per page) used by the spooled file. The valid range is row 1 through 255. The value used should not exceed the actual length of the page used.

Page level index tags. Whether the spooled file contains page level index tags as indicated by the DDS keyword DOCIDXTAG with a tag level of PAGE. The possible values are Y (yes) or N (no).

Page or record being written. The page number or record number currently being written. The page number may be lower or higher than the page number actually being printed because of buffering done by the system. The page number shown may be zero if:

• The printer file is routed to a diskette unit.
• The writer is currently printing job or file separators for the file.

Page position. Whether page positioning errors are reported.

Valid values are Y (yes) or N (no).

Page rotate. Whether the spooled file changes the page rotation to be used within the file.

• For DEVTYPE(*SCS), a Set Text Orientation command is contained in the spooled file.
• For DEVTYPE(*IPDS), a Load Page Descriptor command is contained in the spooled file. See the IPDS Reference manual, S544-3417, for detailed information about rotating text in a spooled file. This manual is available from the IBM Publications Center.
• For DEVTYPE(*AFPDS), a presentation text descriptor (PTD) structured field that specifies the page rotation is contained in the spooled file.

Valid values are Y (yes) or N (no).

Page rotation. The degree of rotation of the text on the page, with respect to the way the form is loaded into the printer.

The possible values are:

-1	*AUTO: Computer output reduction is done automatically if the output is too large to fit on the form, regardless of the print quality.
-2	*DEVD: The operating system sends a device default rotation value to the printer. Page rotation is dependent on the printer's specifications. See your printer or printer emulation documentation to determine how page rotation is affected.
-3	*COR: Output created for a form 13.2 inches wide by 11.0 inches long is adjusted to print on a form 11.0 inches wide by 8.5 inches long.
0	No rotation is done. Printing starts at the edge loaded into the printer first, and is parallel to that edge.
90	Text is rotated 90 degrees clockwise from the 0-degree writing position.
180	Text is rotated 180 degrees clockwise from the 0-degree writing position.
270	Text is rotated 270 degrees clockwise from the 0-degree writing position.

Page width. The page width (in characters per printed line) used by the spooled file. The valid range is column 1 through 378, although some printers have a page width less than 378. The value should not exceed the actual width of the page used.

Point size. The point size in which this file's characters (defined by the printer font field) should be printed.

Print fidelity. The kind of error handling that is performed when printing.

The possible values are:

*ABSOLUTE	The file is printed only if it can be printed exactly as specified in the data stream.
*CONTENT	The printing overrides errors in the data stream and continues printing with the printers best quality based on the content fidelity.

Print on both sides (duplex). How the information prints.

The possible values are:

*FORMDF	The file uses a user-specified form definition. This value is used only for *LINE, *AFPDS, and *AFPDSLINE printer device type files.
*NO	The printing on the page is on one side only.
*YES	The printing is on both sides of the page with the top of each page the same for both sides.
*TUMBLE	The printing is on both sides with the top of one printed page at the opposite end from the top of the other printed page.

Print quality. The print quality that is used when printing this output.

The possible values are:

*STD	Standard
*DEVD	Device default
*DRAFT	Draft
*NLQ	Near-letter quality
*FASTDRAFT	Prints at a faster speed than *DRAFT

Print text. The text that is printed at the bottom of each page of printed output and on separator pages.

Printer device type. The type of data stream used to represent the file.

The possible values are:

*AFPDS	Advanced Function Presentation data stream
*AFPDSLINE	AFPDS data mixed with 1403 line data
*IPDS	Intelligent printer data stream
*LINE	1403 line data
*SCS	Systems Network Architecture (SNA) character stream
*USERASCII	ASCII data

Printer font. The printer font used. If *DEVD is shown, the printer uses the font defined in the printer device description. If *CPI is shown, the file is printed with a font that has the pitch specified by the CPI (character per inch) field.

Profile name of spooled file owner. The name of the user profile that owns the spooled file.

Program that opened file library name. The name of the library that contains the program that opened the file.

Program that opened file name. The name of the program that opened the spooled file.

Record format. The format of the records.

The possible values are:

*FIXED	All records in the file are the same size; that is, the original length field of the print data is the same for all records in the file.
*VARIABLE	Not all records in the file are the same size; that is, the original length field of the print data is the not the same for all records in the file.

Record format name present in data stream. A record format name exists in columns 1-10 of a line data record or columns 2-11 if spooled file contains print control characters. This is not to be confused with DDS record formats. Valid values are Y (yes) or N (no).

N	A record format name is not present in the line data record.
Y	A record format name is present in the line data record.

Record length. The length of the file's records. If the field shows -1 (the special value for *RCDFMT), this is an externally defined file, and the length is included in the file definition. The length includes the extra length of 1 for carriage controls.

Reduce output. The manner in which multiple logical pages print on each side of a physical page.

The possible values are:

*TEXT	A smaller font and lpi are used to print multiple logical pages on each side of a physical page. The smaller font and lpi preserves the contents of each logical page. The possible values for the multiple up parameter are 1, 2, and 4.
*NONE	The printer prints multiple logical pages on each side of each of a physical page. There are no changes to the fonts and lpi values used in each logical page. The possible values for the multiple up parameter are 1, 2, 3, and 4.

Replace unprintable characters. Whether characters that cannot be printed are to be replaced with another character. The options are Y (yes) or N (no).

Replacement character. The character that replaces any unprintable characters. This field has a value if the replace unprintable characters field specifies Y.

Reserved. The field is reserved.

Resource library array. The library names in the library list to use when the spooled file is printed. The variable returns a maximum of 63 ten-character library names. If more than 63 resource libraries are used, a 1 is returned in the 631st character of the variable; otherwise, the 631st character is blank. Use of this field should be for compatibility reasons only. All new development should use the offset to library list, number of library list entries, and length of library list entry fields to access the spooled file's library list located at the end of format SPLA0200.

Restart printing. The number of the page where printing restarts. When you specify a value while the file is printing, the writer stops printing and restarts on the specified page. If the file is not currently printing, this change takes effect after the first copy prints.

The possible values are:

-1	*STRPAGE: The starting page specified in the PAGERANGE parameter is the page on which to restart printing.
-2	*ENDPAGE: Only the last page prints.
-3	*NEXT: The next page of the file to print is the page where printing is restarted.
restart page	The page number you specify is where printing restarts.

Saddle-stitch number of staples. The number of staples in the saddle-stitch.

The valid values are:

0

*DEVD. Use the device default. This value is used if either of the following is specified: The offset of each staple is specified in the saddle-stitch staple offset list. The printer automatically determines the number of staples to be used. Zero (*DEVD) was specified for the number of saddle-stitch staple offset entries field. The printer uses its default value for both the number of staples to be used and the offset of each staple.

1-122

Number of staples to be used in the saddle-stitch.

Saddle-stitch reference edge. The edge of the paper to be used as a reference in determining where the saddle stitching is to be located.

Valid values are:

0	*NONE. No saddle stitching is specified.
1	*DEVD. The default reference edge used by the printer device is specified.
2	*TOP. The top edge of the paper is specified.
3	*LEFT. The left-hand edge of the paper is specified.

Saddle-stitch staple offset. For the spooled file, the placement of staples along the finishing margin in either inches or centimeters (specified in the Unit of measure (UOM) field). The finishing margin can be thought of as an imaginary line parallel to the edge of the paper where the staples will be placed. The position of the finishing margin is the center of the paper relative to the physical edge.

If you want the staples placed parallel to the left edge of the paper, specify the offset of the first staple by measuring from the point where the finishing margin intersects the bottom edge of paper to where you want the center of the staple to be. For subsequent staples, specify the offset by measuring from the same point (not from the previous staple).

If you want the staples placed parallel to the top edge of the paper, specify the offset of the first staple by measuring from the point where the finishing margin intersects the left edge of paper to where you want the center of the staple to be. For subsequent staples, specify the offset by measuring from the same point (not from the previous staple).

The possible values are:

0-57.79

The offset in inches or centimeters, according to the unit of measure value (see Unit of measure). The maximum offset is 57.79 centimeters or 22.75 inches.

Save command. The command used to save the spooled file. The field is blank if the spooled file was not saved.

Save device. The type of device to which the spooled file was last saved. The field is *SAVF if the last save operation was to a save file. The field is *TAP if the last save operation was to tape. The field is *OPT if the last save operation was to optical. The field is blank if the spooled file was not saved.

Save file after written. Whether this file is to be saved after it is written.

The possible values are:

*NO	The file is deleted after it has been written.
*YES	The file is set to save status after it has been written.

Save file library name. The name of the library that contains the save file if the spooled file was saved to a save file. The field is blank if the spooled file was not saved to a save file.

Save file name. The name of the save file if the spooled file was saved to a save file. The field is blank if the spooled file was not saved to a save file.

Save label. The file label used when the spooled file was saved. This field is blank if the spooled file was not saved to tape or optical. This field corresponds to the value specified for the LABEL or OPTFILE parameter on the command used to save the spooled file.

Save sequence number. The tape sequence number assigned when the spooled file was saved on tape. If the spooled file was not saved to tape, the field contains zeros.

Save volume ID. The tape or optical volumes that are used for saving the spooled file. This field returns a maximum of 10 six-character volumes. The volume IDs begin in character positions 1, 8, 15, 22, 29, 36, 43, 50, 57, and 64. Each volume ID entry is separated by a single character. If the spooled file was saved in parallel format, the separator character contains a 2 before the first volume in the second media file, a 3 before the third media file, and so on, up to a 0 before the tenth media file. Otherwise, the separator characters are blank. If more than 10 volumes are used and the spooled file was saved in serial format, 1 is returned in the 71st character of this field. If the spooled file was saved in parallel format, a 2 is returned in the 71st character of this field. Otherwise, the 71st character is blank. The field is blank if the spooled file was last saved to a save file or if it was never saved.

SCS data. Whether the spooled file is created with SCS already in the input data.

Valid values are Y (yes) or N (no).

Set exception. Whether the file has the SCS Set Exception Action (SCS) command in the data stream.

Valid values are Y (yes) or N (no).

Set Line Density command. Whether the lines per inch (lpi) changes within the spooled file or is specified with the Set Line Density SCS command.

For DEVTYPE(*SCS), a Set Line Density command is contained in the spooled file.

Valid values are Y (yes) or N (no).

Source drawer. The drawer to be used when the automatically cut form feed option is selected.

The possible values are:

1-255	The drawer number.
-1	*E1, the envelope drawer.
-2	*FORMDF, indicating that the file uses a user-specified form definition. This value is used only for *LINE, *AFPDS, *IPDS, *SCS, or *AFPDSLINE printer device type files.

Spooled file buffer size. The maximum size of a spooled file buffer. Valid lengths are 512 and 4079.

Spooled file creation authentication method. The authentication method used when the spooled file was created. The possible values are:

0	*NONE No authentication method was used.
1	*REQUESTER The requesting user was used to authenticate the request.
2	*BASIC The client requested the user to sign on with a userid and password to authenticate the request.
3	*CERTIFICATE The request was authenticated through the use of certificates.

Spooled file creation security method. The security method used when the spooled file was created. The possible values are:

0	*NONE No security method was used.
1	*SSL3 The SSL3 security method was used.

Spooled file level. The level of the spooled file in Version, Release, and Modification level format (VxRxMx).

Spooled file name. The name of the spooled file whose information is retrieved.

Spooled file number. The spooled file number of the specified file.

Spooled file size. The spooled file size. Multiply this field by the spooled file size multiplier field to get the size of the spooled file in number of bytes. The spooled file size is the data stream size plus the "overhead" storage used to store the spooled file's data stream.

Spooled file restored date and time. The date and time, in local job time, that the spooled file was last restored. This field is blank if the spooled file was not restored. The date and time is in the CYYMMDDHHMMSS format as follows:

C	Century, where 0 indicates years 19xx and 1 indicates years 20xx.
YY	Year
MM	Month
DD	Day
HH	Hour
MM	Minute
SS	Second

Spooled file saved date and time. The date and time, in local job time, that the spooled file was last saved. This field is blank if the spooled file was not saved. The date and time is in the CYYMMDDHHMMSS format as follows:

C	Century, where 0 indicates years 19xx and 1 indicates years 20xx.
YY	Year
MM	Month
DD	Day
HH	Hour
MM	Minute
SS	Second

Spooled file size multiplier. The number to multiply the spooled file size field by to get the spooled file size in number of bytes.

Starting page. The page at which printing is to start for the file.

The possible values are:

0	Printing starts on page 1.
-1	Use the ending page value.
1-2147483647	Number of page to start printing from.

Status. The status of the file is one of the following values:

*CLOSED	The program completely processed the file, but SCHEDULE(*JOBEND) was specified, and the job that produced the file has not yet finished.
*DEFERRED	The spooled file has been deferred from printing.
*SENDING	The spooled file is being sent or has been sent to a remote system.
*HELD	The file is held.
*MESSAGE	The file has a message requiring a reply or an action.
*OPEN	The file was not completely processed and is not ready for a writer.
*PENDING	The file is pending to be printed.
*PRINTER	The complete file was sent to the printer, but a print complete status was not sent back.
*READY	The file is available to be written.
*SAVED	The file was written and is saved. This file remains saved until it is released.
*WRITING	The writer is writing the file on a diskette or a printer device.

Subscript. Whether the spooled file contains subscript.

• For DEVTYPE(*SCS), a Subscript command is contained in the spooled file.
• For DEVTYPE(*IPDS and *AFPDS), a Temporary Baseline Move text control is contained in the spooled file.

Valid values are Y (yes) or N (no).

Superscript. Whether the spooled file contains superscript.

• For DEVTYPE(*SCS), a Superscript command is contained in the spooled file.
• For DEVTYPE(*IPDS and *AFPDS), a Temporary Baseline Move text control is contained in the spooled file.

Valid values are Y (yes) or N (no).

System where file originated. The name of the system where the spooled file data stream was originally generated for this spooled file. If the creating system was a System i product running OS/400^® version 2 or earlier, the address of the user that sent the file is displayed.

When the name of the system where this spooled file was created cannot be determined, the receiving system name is used. For example, a file sent using SNDNETSPLF DTAFMT(*RCDDATA).

System/36 procedure name. The name of the procedure running when the spooled file was created.

System/36 spooled file identifier. The 6-character identifier assigned to the spooled file.

The possible formats are:

SPxxxx	SP is constant, and xxxx is a number from 0000 to 9999.
cxxxxx	c is a letter from 'A' to 'Z' and xxxxx is a number from 00000 to 99999.
blanks	The spooled file resides on an independent disk pool and does not have a System/36 spooled file identifier.

System/38 text utility flags. The flag for advanced functions.

When you create a file that will contain data that has never been spooled before, set the field to hexadecimal zeros (hex 00).

S36 CONTINUE-YES. The file was created with the System/36 environment OCL statement "// PRINTER CONTINUE-YES" in effect. See the System/36 Environment Reference manual, SC41-4731, for more information.

This field should only be changed by IBM i.

A spooled file created in this manner can change its overflow line number and maximum print position from within its print data stream. When it is printed, the writer needs to know that the page size may have changed and it needs to reset the printer before printing the next spooled file. Otherwise, the next spooled file printed may cause a printer error or data loss. The options are Y (yes) or N (no).

Time file opened (created). The time, in local job time, that the file was opened in the HHMMSS format where:

HH	Hour
MM	Minutes
SS	Seconds

Time writer began processing spooled file. The time, in local job time, that a spooling writer started processing the spooled file. This field is set to blanks if the file has not been processed by a writer. The time is in the HHMMSS format where:

HH	Hour
MM	Minutes
SS	Seconds

Time writer completed processing spooled file. The time, in local job time, that a spooling writer completed processing the spooled file or the time the processing of the spooled file was aborted. This field is set to blanks if the file has not been processed by a writer or the writer has not completed processing the file. The time is in the HHMMSS format where:

HH	Hour
MM	Minutes
SS	Seconds

Total copies. The total number of copies to be produced for this printer file.

Total pages. The number of pages this printer file contains.

Total records. If the spooled file data stream is *AFPDS, *AFPDSLINE, or *LINE or the spooled file device type is diskette, this field contains the total number of records in the printer file or the diskette file. The field is blank if the file is open.

Transparency. Whether the SCS Transparency command is used in the spooled file. It is set to N for all other device type files, such as IPDS.

For DEVTYPE(*SCS), a TRANSPARENT SCS command is contained in the spooled file.

Valid values are Y (yes) or N (no).

TRC for 1403. Whether the file contains 1403 line data with table-reference characters (TRC). This field is only used for device types *LINE and *AFPDSLINE.

Valid values are Y (yes) or N (no).

Unit of measure. The unit of measure to use for specifying distances. The unit of measure is used with certain parameters of the printer file. Page definitions and form definitions are examples of these parameters.

The possible values are:

*CM	Centimeters
*INCH	Inches

Unrecognizable data. Whether the file contains SCS commands that are not valid because of one of the following:

• Command is not recognized
• Command data is not valid
• Command is recognized, but not supported

Valid values are Y (yes) or N (no).

User name. The name of the user that owns the spooled file.

User object type. The type of the user-defined object.

The following values are supported:

blanks	The user-defined object is *NONE.
User object type	The user object type can be: *DTAARA Data area *DTAQ Data queue *FILE File *PSFCFG PSF configuration object *USRIDX User index *USRQ User queue *USRSPC User space

User-defined data. Data defined by the user to be used by user applications or user-specified programs that process spooled files.

The following values are supported:

*NONE	No user-defined data is specified.
User-defined data	Data defined by the user.

User-defined file. Whether the spooled file was created by using an API.

The possible values are:

*YES	The spooled file was created using the QSPCRTSP API.
*NO	The spooled file was created by normal system functions.

User-defined object library name. The name of the library that contains the user-defined object.

User-defined object name. The name of the user-defined object that is used by user applications or user-specified programs that process spooled files.

The following values are supported:

*NONE	No user-defined object is specified.
User-defined object name	The name of the object defined by the user.

User-defined option. The option defined by the user to be used by user applications or user-specified programs that process spooled files.

The possible values are:

*NONE	No user-defined options are specified.
User-defined option	The value of a user-defined option.

User-defined text. User-defined text taken from the interactive user profile when the spooled file was created.

User-generated data stream. Whether the data stream has been validated by a system program on the System i platform when the file was spooled, for example, the OfficeVision program.

Valid values are Y (yes) or N (no).

User-specified data. The 10 characters of user-specified data that describe the file.

User who owned file. The name of the user profile that owns this file. If the spooled file was created on a System i platform running OS/400 version 2 or earlier, the user id that sent the file is displayed.

When the name of the user profile that owned this file cannot be determined, the name of the receiving user profile is used. For example, a file sent using SNDNETSPLF DTAFMT(*RCDDATA).

User resource library. The name of the user resource library.

Volumes (array). The diskette volumes used for saving the object. The variable returns a maximum of 10 six-character volumes. The volume IDs begin in character positions 1, 8, 15, 22, 29, 36, 43, 50, 57, and 64. If more than 10 volumes are used, a 1 is returned in the 71st character of the variable; otherwise, the 71st character is blank. The variable is returned blank if the object was saved to a save file, or if it was never saved.

Width of drawer 1. The width in inches of the paper in drawer 1. This field is for internal use and should be set to 0 by an application building this format as opposed to retrieving the fields.

Width of drawer 2. The width in inches of the paper in drawer 2. This field is for internal use and should be set to 0 by an application building this format as opposed to retrieving the fields.

Width of page. The width of a page. Units of measurement are specified in the measurement method field.

3812 SCS. Whether the spooled file contains fonts supported only on the 3812 printer.

For DEVTYPE(*SCS), a Set Coded Font Local command with a global ID of greater than 255 is contained in the spooled file.

Valid values are Y (yes) or N (no).

3812 SCS commands. Whether the file contains commands that are not valid on the 3812 printer.

• An incorrect Set Character Set Global ID is found by validity checking the code page with what is valid for the 3812 printer.
• An incorrect Set Character Set Local ID is found by validity checking the code page with what is valid for the 3812 printer.
• A Set Presentation Color command

Valid values are Y (yes) or N (no).

5A present. Whether the 5A hexadecimal constant is present in all AFPDS data for the file (in format SPLF0200).

Valid values are Y (yes) or N (no).

5219 commands. Whether the file contains commands that are not valid on a 5219 printer. The data stream contains one or more of the following SCS commands which, either are not valid on a 5219 or contain parameters that are not valid.

• An incorrect Set Character Set Global ID is found by validity checking the code page with what is valid for the 5219 printer.
• Begin and End Emphasis SCS commands.
• A Set Presentation Page Size command contains a page size value that is not supported.
• A Page Presentation Media command contains a drawer value other than drawer 1 or drawer 2.
• A Set Single Line Distance command contains a distance value that is not supported.
• A Set Single Line Spacing command contains a distance value that is not supported.
• A Justify Text Field Format command contains a value other than 0, 50, or 100 percent.
• A Set Justify Mode Format command contains a value other than 0, 50, or 100 percent.
• A Set Presentation Color command.
• A Begin Overstrike command, which contains an optional CHRID value of other than 0.

Valid values are Y (yes) or N (no).

Error Messages

Message ID	Error Message Text
CPF24B4 E	Severe error while addressing parameter list.
CPF3CF1 E	Error code parameter not valid.
CPF3C19 E	Error occurred with receiver variable specified.
CPF3C20 E	Error found by program &1.
CPD3C21 D	Format name &1 is not valid.
CPD3C24 D	Length of the receiver variable is not valid.
CPD3C40 D	Spooled file number &1 is not valid.
CPD3C42 D	User name or job number is not blank.
CPD3C43 D	Internal job identifier is not valid.
CPD3C44 D	Internal spooled file identifier is not valid.
CPD3C58 D	Job name specified is not valid.
CPD33C9 D	Spooled file name parameter cannot be blank.
CPD335B D	Spooled file create date is not blank.
CPD3360 D	Job system name is not valid.
CPD3361 D	Spooled file create date is not valid.
CPD3362 D	Spooled file create time is not valid.
CPD3363 D	Spooled file create time is not blank.
CPD3364 D	Job system name is not blank.
CPF3C21 E	Format name &1 is not valid.
CPF3C24 E	Length of the receiver variable is not valid.
CPF3C33 E	Spooled file number &1 is not valid.
CPF3C36 E	Number of parameters, &1, entered for this API was not valid.
CPF3C40 E	Spooled file &4 not found.
CPF3C41 E	More than one spooled file with same name.
CPF3C42 E	User name or job number is not blank.
CPF3C43 E	Internal job identifier is not valid.
CPF3C44 E	Internal spooled file identifier is not valid.
CPF3C58 E	Job name specified is not valid.
CPF3C90 E	Literal value cannot be changed.
CPF33C9 E	Spooled file name parameter cannot be blank.
CPF3309 E	No files named &1 are active.
CPF3330 E	Necessary resource not available.
CPF333B E	Job system name is not valid.
CPF333C E	Spooled file create date is not valid.
CPF333D E	Spooled file create time is not valid.
CPF333E E	Spooled file create time is not blank.
CPF333F E	Job system name is not blank.
CPF3342 E	Job &5/&4/&3 not found.
CPF3343 E	Duplicate job names found.
CPF3344 E	File &1 number &2 no longer in the system.
CPF335B E	Spooled file create date is not blank.
CPF9872 E	Program or service program &1 in library &2 ended. Reason code &3.

---

API Introduced: V1R3

---

[ Back to top | >Print APIs | APIs by category ]