IBM Version 4 manual Format, Field Descriptions, Error Messages, Optional Parameter Group

with	a value	of.6/zeroon page( 3-7) must be passed. This indicates to th
that	you want	exception messages sent.

Optional Parameter Group

Some of the APIs have optional parameters; the optional parameters fo You must either include or exclude the entire group. You cannot use parameters by itself. You must include all preceding parameters.

The API can be called two ways: either with the optional parameters optional parameters.

The	Retrieve	Job Description Information API has	no	optional	paramete
The	List Job	(QUSLJOB) API is an example of an	API	with an	optional
group.

Format

The Format topic describes a format name, which for the Retrieve J (QWDRJOBD) API is JOBD0100. Listed within the format are the individ that contain the attributes of the job descriptionDec (decimal.Theoffset in offset) column for the hold on job queue field (hold parameter on t Description command) begins at decimal offset 76. For more information o format, see “JOBD0100 Format” on page 3-30.

The	fields	in	the format do not occur in any particular sequence. Y
the	format	to	determine what		you	want.
This	API has		only a single	format;		other APIs may	have	multiple	format
each	format has different levels of information. With multiple formats,
name	parameter		allows you	to	specify which format		you	want to	retri

Field Descriptions

The	Field Descriptions			topic	describes the fields found in			the	form
of	the	format are presented in				alphabetical sequence	and	not in	th
the fields defined in the format. In the Retrieve Job Description
example,		you	can find	the	description of the hold on		job	queue	fi
not	use	the	parameter	name	found	on the Create Job	Description		(CR
command.

Error Messages

The	Error	Messages		topic lists error messages that		can	occur	when yo
API.	These	are	message IDs that normally exist		in	the	QCPFMSG	file. Yo
want	to program		for	these messages regardless	of	the	high-level langu
are using. If you need more detail about the messages, use the D
Description		(DSPMSGD)		command.

Extracting a Field from	the Format
The format describes where the field that you want is located							wit
variable. An offset is shown in		both decimal and hexadecimal. Dependin
which language you use, either		offset may be helpful. For			CL	and	RP
normally use the decimal offset.		With	any offset,	it is important			to
whether your language works with		an offset from a base of			0	or	a
format	tables Systemin the API Referenceare		prepared for	languages	that		work

Chapter 3. Common Information across APIs—Basic (OPM) 3-Example5