IBM Version 4 manual Characteristics of a List, General Data Structure

Chapter 5. List APIs

This	chapter		contains an	overview	of list APIs, which are				those	APIs
list	unique	to	a given	API. The	chapter	discusses	the	characteristic
and	provides	information		that you	should	be aware	of	when	you	use

The List Objects That Adopt Owner Authority (QSYLOBJP) API is referre throughout this chapter. The QSYLOBJP API is included in “List Objects Adopt Owner Authority API—Example” on page 5-12 if you need to refer you read this chapter.

Characteristics of a List	API
As discussed in “User Spaces” on page 2-13,				list	APIs	return	informat
space. List		APIs	generally have a user space	parameter		that	uses a
common) data		structure. You must use the general data structure to g
information		placed	in the user space by the	list	API.

General Data Structure

This topic describes some of the more important fields that comprise data structure. Figure 5-1 on page 5-2 shows the common fields that lis use. All list APIs have an input parameter section, a header section, section.

User Area

The	first		field in		the	general	data structure	is called the user
field		that	is	not	used or changed by the system. Whatever informat
this	field		remains		there. For example, you may			specify the date la
comments		about		the	list,	and so	forth.

Size

of

Generic

Header

The

size of the generic header does not include

the

size

of

the

sections

have

a size,

which

may

differ

for

each

API.

Some

fields may be added to the generic header

from

release

to

fields

may

be

added,

you

may

want

to check

the

size

of

this

fi

tion

works across multiple releases, it

is recommended that you check

this

field

to

determine

which fields

are

applicable.

Offset

to

Input

Parameter

Section

The

offset

to

input

parameter section is an offset to the start o

section. The

input

parameter

section

may contain

a

copy

of

the input

that

you pass to the list

API. The

QSYLOBJP API's

input

parameter

se

shown on page 5-14.

The

input

parameter

section contains a copy of the continuation handle

you

passed

as

the

continuation handle

parameter

to

the

API. “Other

F

Generic

Header”

on

page 5-3

discusses

continuation

handles

further.

 Copyright IBM Corp. 1997 5-1