List Spooled File AFPDS Resources (QGSLRSC) API

Required Parameter Group:

1	Qualified user space name	Input	Char(20)
2	Format name	Input	Char(8)
3	Qualified job name	Input	Char(26)
4	Internal job identifier	Input	Char(16)
5	Internal spooled file identifier	Input	Char(16)
6	Spooled file name	Input	Char(10)
7	Spooled file number	Input	Binary(4)
8	Resource name	Input	Char(*)
9	Resource object type	Input	Char(10)
10	Pel density	Input	Char(1)
11	Error code	I/O	Char(*)

Optional Parameter Group 1:

12	Job system name	Input	Char(8)
13	Spooled file create date	Input	Char(7)
14	Spooled file create time	Input	Char(6)

Optional Parameter Group 2:

15	Length of resource name	Input	Binary(4)
16	CCSID of resource name	Input	Binary(4)

Default Public Authority: *USE

Threadsafe: No

The List Spooled File AFPDS Resources (QGSLRSC) API generates a list of the AFPDS resources found in the specified spooled file or returns the location of a specified AFPDS resource. Either option returns the information in a user space.

How QGSLRSC Resolves to the AFPDS Resource Libraries

If a spooled file is specified, the spooled file attribute, user resource library list, is used to resolve the location of the AFPDS resources. The following is a list of supported values of the user resource library list and how QGSLRSC uses them:

*JOBLIBL. The library list of the job that created the spooled file is searched.
*NONE. No libraries associated with the spooled file are searched.
*CURLIB. The current library of the job that created the spooled file is searched.
*DEVD. Same as *JOBLIBL.
1-4 libraries. The specified libraries are searched.

If the AFPDS resource is not found at this point, then the font libraries QFNTCPL, QFNT01-QFNT19, and QFNT61-QFNT69 are searched.

If *NONE was specified for the spooled file, then only the font libraries QFNTCPL, QFNT01-QFNT19, and QFNT61-QFNT69 are searched.

How QGSLRSC resolves to integrated file system imbedded object resources

When an imbedded object resource is specified or encountered within the data stream of the spooled file, the following method is used to resolve to the resource.

If the resource is qualified with a path name, that path is searched.
If the resource was not found in a specified path, and the path was the current working directory or the resource was not path qualified, the paths specified in the system-level environment variable QIBM_AFP_RESOURCES_PATH is searched.
If the resource is not found, and the spooled file resides on an independent disk pool, the /independent-disk -pool-name/QIBM/UserData/OS400/AFPresources directory on the independent disk pool is searched.
If the resource is not found, or the spooled file resides on *SYSBAS, the /QIBM/UserData/OS400/AFPresources directory on the system ASP is searched.

How QGSLRSC Resolves to integrated file system font resources

When a font is specified or encountered within the data stream of the spooled file, the Resource Access Table in following directories are searched first. If the font is not found in one of the Resource Access Tables or if there are no Resource access Tables, then the files in the directories are searched.

/QIBM/UserData/OS400/Fonts/TTFonts
/QIBM/ProdData/OS400/Fonts/TTFonts

Authorities and Locks

User Space Authority: *CHANGE
Library Authority: *EXECUTE
Output Queue Authority: *USE
Resource Authority: *READ/*R
Directory Authority: *X

Spooled File Authority

The requester is authorized to the spooled file if one or more of the following conditions are met:

The requester is the owner of the spooled file.
The requester has *READ authority to the queue on which the spooled file resides, and the queue is specified as DSPDTA(*YES).
The requester has *SPLCTL authority.
The requester has *JOBCTL authority, and the output queue on which the spooled file resides is specified as OPRCTL(*YES).
The requester has ownership of the queue on which the spooled file resides, and the queue is specified as AUTCHK(*OWNER).
The requester has read, add, and delete authorities to the output queue on which the spooled files resides, and the output queue is specified as AUTCHK(*DTAAUT).

Spooled File Lock: *LSRD
User Space Lock: *EXCLRD

Required Parameter Group

Qualified user space name

INPUT; CHAR(20)

The user space that receives the generated list and the library in which it is located. The first 10 characters contain the user space name and the second 10 characters contain the library name.

You can use these special values for the library name:

*CURLIB	The job's current library
*LIBL	The library list

Format name

INPUT; CHAR(8)

The format of the AFPDS resource list being returned. You must specify one of the following:

LRSC0100	Contains the name, object type, and location of the AFPDS resource.
LRSC0200	Contains the library list of the specified spooled file where the AFPDS resources can be found.
LRSC0300	Searches the library list for the specified resource using the spooled file library list and the font libraries.
LRSC0400	Contains the name, object type, and location of the AFPDS resource if the resource is a library based object. Contains the file name and path if the resource is not a library based object and is in the integrated file system.
LRSC0500	Searches the integrated file system directories for the specified resource.

Qualified job name

INPUT; CHAR(26)

The qualified job name of 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 in which this program is running. The rest of the job name parameter must be blank.
*INT	The internal job identifier used to locate the job. The user name and job number must be set to blank.

user name

CHAR(10)

A specific user profile name, or blank when the job name is asterisk (*) or *INT.

job number

CHAR(6)

A specific job number, or blank when the job name is asterisk (*) or *INT.

Internal job identifier

INPUT; CHAR(16)

The internal job identifier for the job that owns the spooled file whose AFPDS resources are to be listed, or blank when job name is not *INT. See Retrieve Spooled File Attributes (QUSRSPLA) API for valid combinations of parameters for selecting the spooled file.

Internal spooled file identifier

INPUT; CHAR(16)

The internal spooled file identifier for the spooled file whose AFPDS resources are to be listed, or blank when the spooled file name is not *INT. See Retrieve Spooled File Attributes (QUSRSPLA) API for valid combinations of parameters for selecting the spooled file.

Spooled file name

INPUT; CHAR(10)

The name of the spooled file for which the list of AFPDS resources is returned. You can use these special values for the name:

*INT	The internal spooled file identifier is used to locate the spooled file.
*NONE	Search the font libraries for the specified resource. When this is specified, the input parameters qualified job name, internal job identifier, internal spooled file identifier, spooled file number, job system name, spooled file create date, and spooled file create time are ignored. This value is only valid with format LRSC0300 or LRSC0500.

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.
	This parameter must contain a valid value even if the value for the spooled file name parameter is *INT.

Resource name

INPUT; CHAR(*)

The name of the AFPDS resource to be returned in the list of AFPDS resources.

You must specify one of the following:

*ALL	Returns a list of all AFPDS resources found in the specified spooled file. This is valid only for format LRSC0100 or LRSC0400.
resource name	Returns information for the specified AFPDS resource if it is found in the specified spooled file. The resource name must be one of the following:

An IBM^® i object name.
An integrated file system file name. The file name must include the proper extension. The file name must not include a path name.
An external descriptive font name. An example of an external descriptive font name would be Times New Roman. An external descriptive font name can only be specified for format LRSC0500.

For format LRSC0300, the library information is returned for the specified resource.

For format LRSC0500, the path information is returned for the specified resource.

This parameter is ignored when using format LRSC0200.

Resource object type

INPUT; CHAR(10)

The type of resource object. When the resource object type is *PATH, optional parameters Length of resource name and CCSID of resource name must be specified.

The valid values for this parameter are:

*ALL	Search for all AFPDS resources in the spooled file. This value is valid for format LRSC0100 and LRSC0400 only.
*FNTRSC	Font resource
*FORMDF	Form definition
*OVL	Overlay
*PAGSEG	Page segment
*PAGDFN	Page definition
*PATH	The resource resides in the integrated file system. This value is valid for formats LRSC0400 and LRSC0500 only.
	This parameter is ignored when using format LRSC0200.

Pel density

INPUT; CHAR(1)

The pel density of the font resources that are to be returned in the list of AFPDS resources. This parameter is only used for AFPDS resources of type *FNTRSC with the attribute FNTCHRSET.

The valid values for this parameter:

1	240 pel density.
2	300 pel density.
3	Adobe Type 1 outline font.
4	Adobe Type 0 composite outline font.
5	600 pel density.

Error code

I/O; CHAR(*)

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

Optional Parameter Group 1

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 or blank when the spooled file name is *INT. 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.

Optional Parameter Group 2

Length of resource name: INPUT; Binary(4); The length of the resource name in number of bytes. Valid values range from 1 to 250. A value larger than 250 will result in an error.; If this parameter is omitted, the API assumes a fixed length of 10 and that the resource name is left justified and blank padded.
CCSID of resource name: INPUT; Binary(4)

The CCSID that the resource name specified in the resource name parameter is encoded in. The CCSID or the following special value:

0	The current job's default CCSID is used.

If this parameter is omitted, the API assumes CCSID 65535.

Format of the Generated List

The spooled file AFPDS resource list consists of:

A user area
A generic header
An input parameter section
A header section
A list data section

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

Note: When the entry size returned in the generic header is set to -1, the entries vary in length. To get to the next entry, the entry length field of the LRSC0400 or LRSC0500 formats must be used to determine the displacement to the next list entry.

Input Parameter Section

For more information about the fields in the following table, see Field Descriptions.

Offset		Type	Field
Dec	Hex	Type	Field
0	0	CHAR(10)	User space name specified
10	A	CHAR(10)	User space library name specified
20	14	CHAR(8)	Format name
28	1C	CHAR(26)	Qualified job name specified
54	36	CHAR(16)	Internal job identifier
70	46	CHAR(16)	Internal spooled file identifier
86	56	CHAR(10)	Spooled file name specified
96	60	BINARY(4)	Spooled file number specified
100	64	CHAR(10)	Resource name specified
110	6E	CHAR(10)	Resource object type specified
120	78	CHAR(1)	Pel density specified
121	79	CHAR(8)	Job system name specified
129	81	CHAR(7)	Spooled file create date specified
136	88	CHAR(6)	Spooled file create time specified
142	8E	Char(2)	Reserved
144	90	Binary(4)	Displacement to resource name specified
148	94	Binary(4)	Length of resource name specified
152	98	Binary(4)	CCSID of resource name specified
		Char(*)	Long resource name specified

Field Descriptions

CCSID of resource name specified. The CCSID of the resource name parameter value specified on the call to the API. This field is set to 65535 when the CCSID of the resource name parameter is not specified.

Displacement to resource name specified. The displacement, in number of bytes, from the beginning of the Input parameter section to the long resource name specified. This resource name is the one that was specified in the call to the API. This field is set to 0 if the resource object type specified is not *PATH.

Format name. The name of the format used to list the AFPDS resources in the user space.

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.

Internal spooled file identifier. The input value that other programs use to improve the performance of locating the spooled file on the system. Only the spooled file 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.

Job system name specified. The name of the system, specified on the call to the API, where the job specified by the qualified job name ran.

Length of resource name specified. The length of the resource name parameter value specified on the call to the API. This field is set to 10 when the length of resource name parameter is not specified.

Long resource name specified. The name of the AFPDS resource specified in the call to the API.

Pel density specified. The pel density specified on the call to the API.

The valid values are:

1	240 pel density
2	300 pel density
3	Adobe Type 1 outline font.
4	Adobe Type 0 composite outline font.
5	600 pel density.

Qualified job name specified. The qualified name of the job specified in the call to the API.

Resource name specified. The name of the AFPDS resource specified in the call to the API. This field is blank when the resource object type specified is *PATH.

Resource object type specified. The type of the AFPDS resource specified in the call to the API.

Spooled file create date specified. The creation date of the spooled file specified on the call to the API.

Spooled file create time specified. The creation time of the spooled file specified on the call to the API.

Spooled file name specified. The name of the spooled file specified in the call to the API.

Spooled file number specified. The number of the spooled file specified in the call to the API.

User space library name specified. The library name of the user space specified in the call to the API.

User space name specified. The name of the user space specified in the call to the API.

Header Section

For more information about the fields in the following table, see Field Descriptions.

Offset		Type	Field
Dec	Hex	Type	Field
0	0	CHAR(10)	User space name
10	A	CHAR(10)	User space library name
20	14	CHAR(26)	Qualified job name
46	2E	CHAR(10)	Spooled file name
56	38	BINARY(4)	Spooled file number
60	3C	CHAR(8)	Job system name
68	44	CHAR(7)	Spooled file create date
75	4B	CHAR(6)	Spooled file create time
81	51	CHAR(3)	Reserved
84	54	BINARY(4)	CCSID of resource names returned

Field Descriptions

CCSID of resource names returned. The CCSID of the resource names and path names returned for resources located in the integrated file system.

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

Qualified job name. The qualified name of the job that owns the spooled files.

The qualified job name has three parts:

job name	CHAR(10)
	The name of the job that owns the spooled file.
user name	CHAR(10)
	The name of the user of the job.
job number	CHAR(6)
	The number of the job that owns the spooled file.

Spooled file create date. The date, based on local job time, that the spooled file was created on the system.

Spooled file create time. The time, in local job time, that the spooled file was created on the system.

Spooled file name. The name of the spooled file that the AFPDS resources are to be listed for.

Spooled file number. The number of the spooled file that the AFPDS resources are to be listed for.

User space library name. The library containing the user space.

User space name. The name of the user space that contains the format returned.

Format LRSC0100

For more information about the fields in the following table, see Field Descriptions.

Offset		Type	Field
Dec	Hex	Type	Field
0	0	CHAR(10)	Resource name
10	A	CHAR(10)	Resource library name
20	14	CHAR(10)	Resource object type
30	1E	CHAR(1)	Where resource was referenced
31	1F	CHAR(1)	Resource availability
32	20	CHAR(10)	Source object
42	2A	CHAR(10)	Source object library
52	34	CHAR(10)	Source object type

Field Descriptions

Resource availability. Whether the resource was found, not found, or the owner of the spooled file was not authorized to the resource or to the resource library.

Possible values are:

0	The resource was not available for one of the following reasons: The resource could not be found on the system. The user who created the spooled file was not authorized to the resource or to the resource library.
1	The resource was found on the system.

Resource library name. The name of the library that contains the AFPDS resource. The

possible values are:

*INLINE	The resource is defined within the data stream of the spooled file.
library_name	The name of the library that the AFPDS resource was found in.

Resource name. The name of the AFPDS resource used in the spooled file.

Resource object type. The type of AFPDS resource.

The valid values are:

*PAGSEG	Page segment
*PAGDFN	Page definition
*OVL	Overlay
*FORMDF	Form definition
*FNTRSC	Font resource

Source object. The name of the object that the resource was found in.

The possible values are:

*SPLF	The resource is found within the data stream of the spooled file.
object_name	The name of the AFPDS resource that the resource object is found in.

Source object library. The library that contains the source AFPDS resource object. This field is blank when the source object is *SPLF.

Source object type. The object type of the source AFPDS resource object. This field is blank when the source object is *SPLF or is one of the following special values:

*PAGSEG	Page segment
*PAGDFN	Page definition
*OVL	Overlay
*FORMDF	Form definition
*FNTRSC	Font resource

Where resource was referenced. Where the resource was located.

Possible values are:

0	The resource was found within the spooled file or another AFPDS resource.
1	The resource was found within the spooled file attributes.

Format LRSC0200

For more information about the fields in the following table, see Field Descriptions.

Offset		Type	Field
Dec	Hex	Type	Field
0	0	CHAR(10)	Resource library

Field Descriptions

Resource library. A library, from the library list of the specified spooled file, where AFPDS resources can be found.

Format LRSC0300

For more information about the fields in the following table, see Field Descriptions.

Offset		Type	Field
Dec	Hex	Type	Field
0	0	CHAR(10)	Resource name
10	A	CHAR(10)	Resource library name
20	14	CHAR(10)	Resource object type
30	1E	CHAR(1)	Reserved
31	1F	CHAR(1)	Resource availability

Field Descriptions

Resource availability. Whether the resource was found, not found, or the caller or the owner of the spooled file was not authorized to the resource or to the resource library.

Possible values are:

0	The resource was not available for one of the following reasons: The resource could not be found on the system. The user who created the spooled file was not authorized to the resource or to the resource library. If *NONE was specified for the spooled file name, the caller of the API was not authorized to the resource or to the resource library.
1	The resource was found on the system.

Resource library name. The name of the library that contains the AFPDS resource. The

possible values are:

library_name

The name of the library that the AFPDS resource was found in.

Resource name. The name of the AFPDS resource used in the spooled file.

Resource object type. The type of AFPDS resource.

The valid values are:

*PAGSEG	Page segment
*PAGDFN	Page definition
*OVL	Overlay
*FORMDF	Form definition
*FNTRSC	Font resource

Format LRSC0400

For more information about the fields in the following table, see Field Descriptions.

Offset		Type	Field
Dec	Hex	Type	Field
0	0	BINARY(4)	Length of entry
4	4	BINARY(4)	Displacement to name
8	8	BINARY(4)	Length of name
12	0C	CHAR(8)	Format of name
		CHAR(*)	Name entry

Field Descriptions

Displacement to name.The displacement, in number of bytes, from the beginning of the entry to the name.

Format of name. The format of the name. The possible values are:

LRSE0100	Name entry is returned in the entry format LRSE0100.
LRSE0200	Name entry is returned in the entry format LRSE0200

Length of name.The length of the name in number of bytes.

Length of entry. Length of the entry in number of bytes.

Name entry. The resource returned in the format specified in the field Format of name.

Format LRSE0100

For more information about the fields in the following table, see Field Descriptions.

Offset		Type	Field
Dec	Hex	Type	Field
0	0	CHAR(10)	Resource name
10	A	CHAR(10)	Resource library name
20	14	CHAR(10)	Resource object type
30	1E	CHAR(1)	Where resource was referenced
31	1F	CHAR(1)	Resource availability
32	20	CHAR(10)	Source object
42	2A	CHAR(10)	Source object library
52	34	CHAR(10)	Source object type

Field Descriptions

Resource availability. Whether the resource was found, not found, or the owner of the spooled file was not authorized to the resource or to the resource library.

Possible values are:

0	The resource was not available for one of the following reasons: The resource could not be found on the system. The user who created the spooled file was not authorized to the resource or to the resource library.
1	The resource was found on the system.

Resource library name. The name of the library that contains the AFPDS resource. The

possible values are:

*INLINE	The resource is defined within the data stream of the spooled file.
library_name	The name of the library that the AFPDS resource was found in.

Resource name. The name of the AFPDS resource used in the spooled file.

Resource object type. The type of AFPDS resource.

The valid values are:

*PAGSEG	Page segment
*PAGDFN	Page definition
*OVL	Overlay
*FORMDF	Form definition
*FNTRSC	Font resource

Source object. The name of the object that the resource was found in.

The possible values are:

*SPLF	The resource is found within the data stream of the spooled file.
object_name	The name of the AFPDS resource that the resource object is found in.

Source object library. The library that contains the source AFPDS resource object. This field is blank when the source object is *SPLF.

Source object type. The object type of the source AFPDS resource object. This field is blank when the source object is *SPLF or is one of the following special values:

*PAGSEG	Page segment
*PAGDFN	Page definition
*OVL	Overlay
*FORMDF	Form definition
*FNTRSC	Font resource

Where resource was referenced. Where the resource was located.

Possible values are:

0	The resource was found within the spooled file or another AFPDS resource.
1	The resource was found within the spooled file attributes.

Format LRSE0200

For more information about the fields in the following table, see Field Descriptions.

Offset		Type	Field
Dec	Hex	Type	Field
0	0	CHAR(1)	Resource availability
1	1	CHAR(3)	Reserved
4	4	BINARY(4)	Displacement to resource name
8	8	BINARY(4)	Length of resource name
12	0C	BINARY(4)	Displacement to path name
16	10	BINARY(4)	Length of path name
20	14	BINARY(4)	Displacement to source object data
24	18	BINARY(4)	Length of source object data
28	1C	CHAR(8)	Format of source object data
		CHAR(*)	Resource name
		CHAR(*)	Path name
		CHAR(*)	Source object data

Field Descriptions

Displacement to path name The displacement, in number of bytes, from the beginning of the structure to the path name. This field will be set to zero if the resource name contains the descriptive name of a True Type font.

Displacement to resource name The displacement, in number of bytes, from the beginning of the structure to the resource name.

Displacement to source object data The displacement, in number of bytes, from the beginning of the structure to the source object data.

Length of path name. The length of the path name in number of bytes.

Length of resource name. The length of the resource name in number of bytes.

Length of source object data. The length of the source object data in number of bytes.

Path name. The name of the integrated file system path where the resource resided.

Resource availability. Whether the resource was found, not found, or the owner of the spooled file was not authorized to the resource, the resource library, or the resource directory.

Possible values are:

0	The resource was not available for one of the following reasons: The resource could not be found on the system. The user who created the spooled file was not authorized to the resource, the resource library, or the resource directory.
1	The resource was found on the system.

Resource name. The name of the AFPDS resource used in the spooled file. For a True Type font, the resource name can be the font's descriptive name.

Source object data. The identity of the source object in the format specified in the source object format field.

Source object format The format of the source object. The

possible values are:

LRSS0100	Source object data is returned in the format LRSS0100.
LRSS0200	Source object data is returned in the format LRSS0200

Format LRSS0100

For more information about the fields in the following table, see Field Descriptions.

Offset		Type	Field
Dec	Hex	Type	Field
0	0	CHAR(10)	Source object
10	0A	CHAR(10)	Source object library
20	14	CHAR(10)	Source object type

Field Descriptions

Source object. The name of the object that the resource was found in.

The possible values are:

*SPLF	The resource is found within the data stream of the spooled file.
object_name	The name of the AFPDS resource that the resource object is found in.

Source object library. The library that contains the source AFPDS resource object. This field is blank when the source object is *SPLF.

Source object type. The object type of the source AFPDS resource object. This field is blank when the source object is *SPLF or one of the following special values:

*PAGSEG	Page segment
*PAGDFN	Page definition
*OVL	Overlay
*FORMDF	Form definition
*FNTRSC	Font resource

Format LRSS0200

For more information about the fields in the following table, see Field Descriptions.

Offset		Type	Field
Dec	Hex	Type	Field
0	0	BINARY(4)	Displacement to source object name
4	4	BINARY(4)	Length of source object name
8	8	BINARY(4)	Displacement to source object path name
12	0C	BINARY(4)	Length of source object path name
		CHAR(*)	Source object name
		CHAR(*)	Source object path name

Field Descriptions

Displacement to source object name. The displacement, in number of bytes, from the beginning of the structure to the source object name.

Displacement to source object path name. The displacement, in number of bytes, from the beginning of the structure to the source object path name. This field will be set to zero if the source object name contains the descriptive name of a True Type font.

Length of source object name. The length of the source object name in number of bytes.

Length of source object path name. The length of the path name in number of bytes.

Source object name. The name of the object that the resource was found in. For a True Type font, the source object name can be the font's descriptive name.

Source object path name.The name of the integrated file system path where the source object resides.

Format LRSC0500

For more information about the fields in the following table, see Field Descriptions.

Offset		Type	Field
Dec	Hex	Type	Field
0	0	BINARY(4)	Length of entry
4	4	CHAR(1)	Resource availability
5	5	CHAR(3)	Reserved
8	8	BINARY(4)	Displacement to resource name
12	0C	BINARY(4)	Length of resource name
16	10	BINARY(4)	Displacement to path name
20	14	BINARY(4)	Length of path name
		CHAR(*)	Resource name
		CHAR(*)	Path name

Field Descriptions

Displacement to path name The displacement, in number of bytes, from the beginning of the entry to the path name.

Displacement to resource name The displacement, in number of bytes, from the beginning of the entry to the resource name.

Length of entry. Length of the entry in number of bytes.

Length of path name. The length of the path name in number of bytes.

Length of resource name. The length of the resource name in number of bytes.

Path name. The name of the integrated file system path where the resource resides.

Resource availability. Whether the resource was found, not found, or the caller or the owner of the spooled file was not authorized to the resource, the resource library, or the resource directory.

Possible values are:

0	The resource was not available for one of the following reasons: The resource could not be found on the system. The user who created the spooled file was not authorized to the resource, the resource library, or the resource directory. If *NONE was specified for the spooled file name, the caller of the API was not authorized to the resource, the resource library, or the resource directory.
1	The resource was found on the system.

Resource name. The name of the AFPDS resource used in the spooled file.

Error Messages

Message ID	Error Message Text
CPF247E E	CCSID &1 is not valid.
CPF24B4 E	Severe error while addressing parameter list.
CPF3CF1 E	Error code parameter not valid.
CPF3C20 E	Error found by program &1.
CPF3C21 E	Format name &1 is not valid.
CPF3C33 E	Spooled file number &1 is 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.
CPF33C9 E	Spooled file name parameter cannot be blank.
CPF33CE E	Pel density specified is not valid.
CPF3330 E	Necessary resource not available.
CPF3336 E	Job &5/&4/&3 no longer in the system.
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.
CPF3350 E	Job &5/&4/&3 no longer in the system.
CPF335B E	Spooled file create date is not blank.
CPF34C4 E	List is too large for user space &1.
CPF34CA E	File &1 number &2 not available.
CPF34CC E	Resources cannot be retrieved from diskette files.
CPF34CD E	Value for resource name parameter not valid.
CPF34CE E	Value &1 not valid for resource object type.
CPF34CF E	User profile of the spooled file owner &1 damaged or not found.
CPF34DB E	File *NONE not valid with format &1.
CPF3492 E	Not authorized to spooled file.
CPF811A E	User space &4 in &9 damaged.
CPF9801 E	Object &2 in library &3 not found.
CPF9802 E	Not authorized to object &2 in &3.
CPF9803 E	Cannot allocate object &2 in library &3.
CPF9807 E	One or more libraries in library list deleted.
CPF9808 E	Cannot allocate one or more libraries on library list.
CPF9810 E	Library &1 not found.
CPF9820 E	Not authorized to use library &1.
CPF9830 E	Cannot assign library &1.
CPF9838 E	User profile storage limit exceeded.
CPF9846 E	Error while processing file &1 in library &2.
CPF9872 E	Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V3R7

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