ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaik_5.4.0.1/rzaikcwbrccallpgm.htm

81 lines
4.2 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="reference" />
<meta name="DC.Title" content="cwbRC_CallPgm" />
<meta name="DC.Relation" scheme="URI" content="rzaikrcdpcapilist3.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 1999, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1999, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="cwbrc_callpgm" />
<meta name="DC.Language" content="en-us" />
<!-- 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. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>cwbRC_CallPgm</title>
</head>
<body id="cwbrc_callpgm"><a name="cwbrc_callpgm"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbRC_CallPgm</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Calls the program identified by the handle.
The return code will indicate the success or failure of the program. Additional
messages can be returned by using the message handle that is returned.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY cwbRC_CallPgm(
cwbRC_SysHandle system,
cwbRC_PgmHandle program,
cwbSV_ErrHandle msgHandle);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbRC_SysHandle system - input</dt>
<dd>Handle that was returned by a previous call to the <span class="apiname">cwbRC_StartSysEx</span> function.
It identifies the iSeries™ system.</dd>
<dt class="dlterm">cwbRC_PgmHandle program - input</dt>
<dd>Handle that was returned by a previous call to the <span class="apiname">cwbRC_CreatePgm</span> API.
It identifies the program object. object.</dd>
<dt class="dlterm">cwbSV_ErrHandle msgHandle - output</dt>
<dd>Any returned messages will be written to this object. It is created with
the <span class="apiname">cwbSV_CreateErrHandle</span> API. The messages may be retrieved
through the <span class="apiname">cwbSV_GetErrTextIndexed</span> API. If the parameter
is set to zero, no messages will be retrieved.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Return Codes</h4><p>The following list shows common return
values.</p>
<dl><dt class="dlterm">CWB_OK</dt>
<dd>Successful completion.</dd>
<dt class="dlterm">CWB_COMMUNICATIONS_ERROR</dt>
<dd>A communications error occurred.</dd>
<dt class="dlterm">CWBRC_INVALID_SYSTEM_HANDLE</dt>
<dd>Invalid system handle.</dd>
<dt class="dlterm">CWBRC_INVALID_PROGRAM</dt>
<dd>Invalid program handle.</dd>
<dt class="dlterm">CWBRC_REJECTED_USER_EXIT</dt>
<dd>Command rejected by user exit program.</dd>
<dt class="dlterm">CWBRC_USER_EXIT_ERROR</dt>
<dd>Error in user exit program.</dd>
<dt class="dlterm">CWBRC_PROGRAM_NOT_FOUND</dt>
<dd>Program not found.</dd>
<dt class="dlterm">CWBRC_PROGRAM_ERROR </dt>
<dd>Error when calling program.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>None</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaikrcdpcapilist3.htm" title="Use these APIs to access programs and their parameters.">Remote Command/Distributed Program Call: Access programs APIs list for iSeries Access for Windows</a></div>
</div>
</div>
</body>
</html>