This section describes the APIs that you can use to
perform such functions as creating
programs, retrieving program information, and retrieving
command information to mention a few. The APIs are:
- Activate Bound Program
(QleActBndPgm) activates the specified bound program or service
program and all dependent service programs, and
then initalizes the newly activated service programs.
- Add Associated Space Entry
(QbnAddAssociatedSpaceEntry) is used by a compiler
preprocessor to put data into the associated space of the
created module.
- Add Bindtime Exit
(QbnAddBindtimeExit) is used by a compiler preprocessor to
define an exit program that can be called when a created module
is bound into an ILE program.
- Add Extended Attribute Data
(QbnAddExtendedAttributeData) is used by a preprocessor to
set the extended attribute field of a created module.
- Add Preprocessor Level Data
(QbnAddPreProcessorLevelData) is used to set the level of the
preprocessor used to create a module.
- Call Service Program Procedure
(QZRUCLSP) allows an unbound call to an ILE procedure exported
by a service program.
- Check Command Syntax
(QCMDCHK) performs syntax checking for a single command, and
optionally prompts for the command.
- Create Program
(QPRCRTPG) converts the symbolic representation of a machine
interface (MI) program into a program object.
Before using this information, you should
have some MI programming experience and understand
the concepts in the Machine Interface Functional Reference
book, which is a comprehensive reference to machine interface (MI)
instructions. This book is not accessible online and must
be ordered from Mechanicsburg.
- End Preprocessor
(QbnEndPreProcessor) must be called by every preprocessor after
the output source file and preprocessor information is created.
It records that a preprocessor was called.
- Execute Command
(QCMDEXC) runs a single CL command or can be used to run a
command from within a high-level language or CL program.
- Get Export
(QleGetExp) allows the caller to resolve a pointer to an
export (either data or procedure) either by name or export
number. The pointer is materialized for the specified
activation.
- List ILE Program Information
(QBNLPGMI) gives information about Integrated Language Environment *
(ILE *) programs,
similar to the
Display Program (DSPPGM) command.
- List Module Information
(QBNLMODI) API lists information
about modules similar to the Display Module (DSPMOD) command.
The information is placed in a user space specified by you.
- List Service Program Information
(QBNLSPGM) gives information about service programs, similar to the
Display Service Program (DSPSRVPGM) command.
- Process Commands
(QCAPCMD) performs command analyzer processing on command strings.
Replace Command Exit Program
(QCARPLCM) may be used as the exit program for the QIBM_QCA_CHG_COMMAND for any command.
- Retrieve Associated Space
(QbnRetrieveAssociatedSpace) retrieves data stored with the
QbnAddAssociatedSpaceEntry API.
- Retrieve Command Information
(QCDRCMDI) retrieves information from a command definition object.
- Retrieve Module Information
(QBNRMODI) API lets you retrieve
module information and place it into a single variable in the calling
program
similar to the information returned using the Display
Module (DSPMOD) command. The amount of information
returned is limited to the size of the variable.
- Retrieve Program Associated Space
(QCLRPGAS) retrieves information from the associated space of a
user-state, user-domain program.
- Retrieve Program Information
(QCLRPGMI) retrieves program information
similar to the
Display Program (DSPPGM) command.
- Retrieve Service Program Information
(QBNRSPGM) retrieves service program information
similar to the information returned using the
Display Service Program (DSPSRVPGM) command.
- Scan for String Pattern
(QCLSCAN) is used to scan a string of characters to see if
the string contains a pattern.
- Start Preprocessor
(QbnStartPreProcessor) must be called first by every
compiler preprocessor that has data to be processed during module
creation.
- Store Program Associated Space
(QCLSPGAS) stores information in the associated space of a
user-state, user-domain program.
Exit Programs
Exit programs for the Program and CL Command APIs include the following: