ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/pgm1.htm

107 lines
9.1 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Program and CL Command APIs</title>
<!-- Begin Header Records ========================================== -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- PGM1 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
<!-- RCHVMW2 on 5 Feb 1999 at 15:12:09 -->
<!-- File restructured for V5R2 -->
<!-- 030501 JETAYLOR replaced API and Exit listings with -->
<!-- pagegenerator output from javascript array -->
<!-- 030918 JETAYLOR replaced API and/or Exit listings with -->
<!-- pagegenerator output from javascript array -->
<!-- 031014 JETAYLOR replaced API and/or Exit listings with -->
<!-- pagegenerator output from javascript array -->
<!-- 031111 JETAYLOR replaced API and/or Exit listings with -->
<!-- pagegenerator output from javascript array -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<!-- Java sync-link -->
<body>
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Program and CL Command APIs</h2>
<p>The Program and CL Command APIs create programs, retrieve program
information, list and retrieve module information, activate bound programs,
resolve pointers to exports, and retrieve command information.</p>
<p>Before using the Create Program API, you should have some MI programming
experience and understand the concepts in the
<a href="../rzatk/mitoc.htm">iSeries
Machine Interface instructions</a>, which provides detailed descriptions of the
iSeries<SUP>(TM)</SUP> machine interface instruction fields and the formats of those fields.</p>
<p>The Program and CL Command APIs are:</p>
<!-- ***** NOTE ***** Do not manually update text or links in this section. -->
<!-- Updates made in this section *will* be overlaid by automated tools -->
<!-- Notify User Technologies of needed updates to be made in XML for API finder.-->
<!--***************API BEGIN PASTE***************-->
<ul>
<li><A HREF="qleactbp.htm">Activate Bound Program</A> (QleActBndPgm) activates the specified bound program or service program and all dependent service programs, and then initalizes the newly activated service programs.</li>
<li><A HREF="qleactbpl.htm">Activate Bound Program Long</A> (QleActBndPgmLong) activates the specified bound program or service program and all dependent service programs, and then initalizes the newly activated service programs (64 bit version of QleActBndPgm).</li>
<li><A HREF="qcladdsp.htm">Add Associated Space Entry</A> (QbnAddAssociatedSpaceEntry) is used by a compiler preprocessor to put data into the associated space of the created module.</li>
<li><A HREF="qcladdbe.htm">Add Bindtime Exit</A> (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.</li>
<li><A HREF="qcladdex.htm">Add Extended Attribute Data</A> (QbnAddExtendedAttributeData) is used by a preprocessor to set the extended attribute field of a created module.</li>
<li><A HREF="qcladdld.htm">Add Preprocessor Level Data</A> (QbnAddPreProcessorLevelData) is used to set the level of the preprocessor used to create a module.</li>
<li><A HREF="qzruclsp.htm">Call Service Program Procedure</A> (QZRUCLSP) allows an unbound call to an ILE procedure exported by a service program.</li>
<li><A HREF="qcmdchk.htm">Check Command Syntax</A> (QCMDCHK) performs syntax checking for a single command, and optionally prompts for the command.</li>
<li><A HREF="qprcrtpg.htm">Create Program</A> (QPRCRTPG) converts the symbolic representation of a machine interface (MI) program into a program object.</li>
<li><A HREF="qclendpr.htm">End Preprocessor</A> (QbnEndPreProcessor) must be called by every preprocessor after the output source file and preprocessor information is created. It records that a preprocessor was called.</li>
<li><A HREF="qcmdexc.htm">Execute Command</A> (QCMDEXC) runs a single CL command or can be used to run a command from within a high-level language or CL program.</li>
<li><A HREF="qlegetexp.htm">Get Export</A> (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.</li>
<li><A HREF="qlegetexpl.htm">Get Export Long</A> (QleGetExpLong) 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 (64 bit version of QleGetExp).</li>
<li><A HREF="qbnlpgmi.htm">List ILE Program Information</A> (QBNLPGMI) gives information about Integrated Language Environment * (ILE *) programs, similar to the Display Program (DSPPGM) command.</li>
<li><A HREF="qbnlmodi.htm">List Module Information</A> (QBNLMODI) API lists information about modules similar to the Display Module (DSPMOD) command. The information is placed in a user space specified by you.</li>
<li><A HREF="qbnlspgm.htm">List Service Program Information</A> (QBNLSPGM) gives information about service programs, similar to the Display Service Program (DSPSRVPGM) command.</li>
<li><A HREF="qcapcmd.htm">Process Commands</A> (QCAPCMD) performs command analyzer processing on command strings.</li>
<li><A HREF="qcarplcm.htm">Replace Command Exit Program</A> (QCARPLCM) may be used as the exit program for the QIBM_QCA_CHG_COMMAND for any command.</li>
<li><A HREF="qclras.htm">Retrieve Associated Space</A> (QbnRetrieveAssociatedSpace) retrieves data stored with the QbnAddAssociatedSpaceEntry API.</li>
<li><A HREF="qcdrcmdd.htm">Retrieve Command Definition</A> (QCDRCMDD) retrieves information from a CL command (*CMD) object and generates XML (Extensible Markup Language) source statements that describe the command.</li>
<li><A HREF="qcdrcmdi.htm">Retrieve Command Information</A> (QCDRCMDI) retrieves information from a command definition object.</li>
<li><A HREF="qbnrmodi.htm">Retrieve Module Information</A> (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.</li>
<li><A HREF="qclrpgas.htm">Retrieve Program Associated Space</A> (QCLRPGAS) retrieves information from the associated space of a user-state, user-domain program.</li>
<li><A HREF="qclrpgmi.htm">Retrieve Program Information</A> (QCLRPGMI) retrieves program information similar to the Display Program (DSPPGM) command.</li>
<li><A HREF="qptrtvpo.htm">Retrieve Prompt Override</A> (QPTRTVPO) calls the prompt override program for a specified command and returns the prompt override command string from the prompt override program.</li>
<li><A HREF="qbnrspgm.htm">Retrieve Service Program Information</A> (QBNRSPGM) retrieves service program information similar to the information returned using the Display Service Program (DSPSRVPGM) command.</li>
<li><A HREF="qclscan.htm">Scan for String Pattern</A> (QCLSCAN) is used to scan a string of characters to see if the string contains a pattern.</li>
<li><A HREF="qclstrpr.htm">Start Preprocessor</A> (QbnStartPreProcessor) must be called first by every compiler preprocessor that has data to be processed during module creation.</li>
<li><A HREF="qclspgas.htm">Store Program Associated Space</A> (QCLSPGAS) stores information in the associated space of a user-state, user-domain program.</li>
</ul>
<!--***************API END PASTE***************-->
<p>The Program and CL Command exit programs are:</p>
<!-- ***** NOTE ***** Do not manually update text or links in this section. -->
<!-- Updates made in this section *will* be overlaid by automated tools -->
<!-- Notify User Technologies of needed updates to be made in XML for API finder.-->
<!--***************EXIT PROGRAM BEGIN PASTE***************-->
<ul>
<li><A HREF="xcachg.htm">Command Analyzer Change</A> is called when the command for which it is registered is processed.</li>
<li><A HREF="xcartv.htm">Command Analyzer Retrieve</A> is called when the command for which it is registered is processed.</li>
</ul>
<!--***************EXIT PROGRAM END PASTE***************-->
<br>
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>