Filter
Top Products
APIs and Internal System Objects ......................... 2-31
Performance Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-31
Chapter 3. Common Information across APIs—Basic (OPM) Example .. 3-1
Original Program Model (OPM) API–Scenario ................... 3-1
Finding the API Name to Use ........................... 3-1
Description of an API ................................ 3-2
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Extracting a Field from the Format ........................ 3-5
Retrieving the Hold Parameter (Exception Message)—OPM RPG Example 3-6
Retrieving the Hold Parameter (Error Code Structure)—OPM RPG
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
Accessing the HOLD Attribute—OPM RPG Example .............. 3-17
Accessing a Field Value (Initial Library List)—OPM RPG Example .... 3-19
Using Keys with List Spooled Files API—Example ............... 3-24
Processing Lists That Contain Data Structures .................. 3-29
Retrieve Job Description Information API—Example .............. 3-29
Authorities and Locks ............................... 3-30
Required Parameter Group ........................... 3-30
JOBD0100 Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-30
Field Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-32
Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-36
Chapter 4. Common Information across APIs—Advanced (ILE) Example 4-1
Integrated Language Environment (ILE) APIs—Introduction ........... 4-1
Registration Facility Using ILE APIs—Concepts .................. 4-2
Generic Header Files ................................ 4-2
Keyed Interface—Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Receiver Variables—Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
Registration Facility Using ILE APIs—Examples .................. 4-9
Register Exit Point and Add Exit Program—ILE C Example .......... 4-9
Retrieve Exit Point and Exit Program Information—ILE C Example .... 4-13
Remove Exit Program and Deregister Exit Point—ILE C Example ..... 4-19
Chapter 5. List APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Characteristics of a List API .............................. 5-1
General Data Structure ............................... 5-1
Processing a List .................................... 5-4
List Object API—OPM RPG Example ........................ 5-4
List Objects That Adopt Owner Authority API—Example ............ 5-12
Authorities and Locks ............................... 5-12
Required Parameter Group ........................... 5-12
User Space Variables ............................... 5-14
Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16
Chapter 6. Original Program Model (OPM) and Integrated Language
Environment (ILE) Differences .......................... 6-1
Contrasting OPM and ILE APIs ............................ 6-1
API Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Error Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
iv System API Programming V4R1