APIs
What's new for V5R4
Print these topics
API finder
APIs by category
Alphabetic list of APIs
Concepts
About APIs
API terminology
Generic library names
API verbs and abbreviations
Language selection
API environment
OPM
ILE
ILE CEE
OPM and ILE API differences
Example in ILE C: Logging software error (OPM API without pointers)
Example in COBOL: Logging software error (OPM API without pointers)
Example in OPM RPG: Logging software error (OPM API without pointers)
Example in ILE RPG: Logging software error (OPM API without pointers)
Example in ILE C: Reporting software error (ILE API with pointers)
Example in ILE COBOL: Reporting software error (ILE API with pointers)
Example in ILE RPG: Reporting software error (ILE API with pointers)
UNIX-type
Examples: UNIX-type APIs
API information format
API description
API format
API field description
API error messages
Extracting a field from the format
Processing lists that contain data structures
API parameters
Passing parameters
Input and output parameters
Offset values and lengths
Offset versus displacement
Error code parameter
Include files and QSYSINC library
Internal object types
Data types
Internal identifiers
User spaces and receiver variables
User spaces
Receiver variables
Continuation handle
List APIs overview
List Object API general data structure
User spaces for list APIs
Logic flow of processing a list of entries
Manipulating a user space with pointers
Manipulating a user space without pointers
Changing a user space
Additional information about List APIs and a user space
Example: Listing database file members with a CL program
Example in RPG: List Object API
Example in ILE C: List Object API
Example in ILE RPG: List Object API
Example in ILE COBOL: List Object API
Domain
Exit programs
User index
Performance
APIs and internal system objects
Open list information format
Path name format
Using APIs
Scenario: OPM API
Example in RPG: Retrieving the HOLD parameter (exception message)
Example in COBOL (OPM and ILE): Retrieving the HOLD parameter (exception message)
Example in ILE C: Retrieving the HOLD parameter (exception message)
Example in ILE RPG: Retrieving the HOLD parameter (exception message)
Example in RPG: Retrieving the HOLD parameter (error code structure)
Example in COBOL (OPM and ILE): Retrieving the HOLD parameter (error code structure)
Example in ILE C: Retrieving the HOLD parameter (error code structure)
Example in ILE RPG: Retrieving the HOLD parameter (error code structure)
Example in RPG: Accessing the HOLD attribute
Example in COBOL (OPM and ILE): Accessing the HOLD attribute
Example in ILE C: Accessing the HOLD attribute
Example in ILE RPG: Accessing the HOLD attribute
Example in RPG: Accessing a field value (initial library list)
Example in COBOL (OPM and ILE): Accessing a field value (initial library list)
Example in ILE C: Accessing a field value (initial library list)
Example in ILE RPG: Accessing a field value (initial library list)
Example in RPG: Using keys with List Spooled File API
Example in COBOL (OPM and ILE): Using keys with List Spooled File API
Example in ILE C: Using keys with List Spooled File API
Example in ILE RPG: Using keys with List Spooled File API
Scenario: ILE API
Registration facility using ILE APIs
Example in ILE C: Register exit point and add exit program
Example in OPM COBOL: Register exit point and add exit program
Example in ILE COBOL: Register exit point and add exit program
Example in OPM RPG: Register exit point and add exit program
Example in ILE RPG: Register exit point and add exit program
Example in ILE C: Remove exit program and deregister exit point
Example in OPM COBOL: Remove exit program and deregister exit point
Example in ILE COBOL: Remove exit program and deregister exit point
Example in OPM RPG: Remove exit program and deregister exit point
Example in ILE RPG: Remove exit program and deregister exit point
Example in ILE C: Retrieve exit point and exit program information
Example in OPM COBOL: Retrieve exit point and exit program information
Example in ILE COBOL: Retrieve exit point and exit program information
Example in OPM RPG: Retrieve exit point and exit program information
Example in ILE RPG: Retrieve exit point and exit program information
Performing tasks using APIs
Examples: Packaging your own software products
Examples: Retrieving a file description to a user space
Examples: Using data queues or user queues
Examples
Changing an Active Job
Changing a Job Schedule Entry
Creating a Batch Machine
Creating and Manipulating a User Index
Creating Your Own Telephone Directory
Defining Queries
Deleting Old Spooled Files
Diagnostic Reporting
Generating and Sending an Alert
Listing Directories
Listing Subdirectories
Saving to Multiple Devices
Saving and Restoring System-Level Environment Variables
Scanning String Patterns
Using COBOL Program to Call APIs
Using the Control Device (QTACTLDV) API
Using a Data Queue
Using Environment Variables
Using ILE Common Execution Environment Data APIs
Using the Generic Terminal APIs>
Using Profile Handles
Using Registration Facility APIs
Using Semaphores and Shared Memory
Using SNA/Management Services Transport APIs
Using Source Debugger APIs
Using the Spawn Process and Wait for Child Process APIs
Using the User-Defined Communications Programs for File Transfer
Working with Stream Files
Creating a Program Temporary Fix Exit Program
Using the Operational Assistant Exit Program for Operational Assistant Backup
MI programming
Machine interface instructions
Example: Writing an MI program
Compiling an MI program
Creating an MI version of CLCRTPG
Enhanced version of the MICRTPG program
Creating the MICRTPG2 program
Examples: MI common programming techniques
Program storage
Common API programming errors
Using the error code parameter
Defining data structures
Defining receiver variables
Defining list entry format lengths
Using null pointers with OPM APIs
Defining byte alignment
Using offsets in a user space
Coding for new function