86 lines
4.5 KiB
HTML
86 lines
4.5 KiB
HTML
|
<?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_RunCmd" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikrcdpcapilist2.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_runcmd" />
|
||
|
|
<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_RunCmd</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbrc_runcmd"><a name="cwbrc_runcmd"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbRC_RunCmd</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Issues the command on the system identified
|
||
|
|
by the handle. The return code will indicate success or failure of the
|
||
|
|
command. 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_RunCmd(
|
||
|
|
cwbRC_SysHandle system,
|
||
|
|
const char *commandString,
|
||
|
|
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">const char *commandString - input</dt>
|
||
|
|
<dd>Pointer to a string that contains the command to be issued on the iSeries system.
|
||
|
|
This is an ASCIIZ string.</dd>
|
||
|
|
<dt class="dlterm">cwbSV_ErrHandle msgHandle - output</dt>
|
||
|
|
<dd>Any messages returned from the iSeries server 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_INVALID_POINTER</dt>
|
||
|
|
<dd>Bad or NULL pointer.</dd>
|
||
|
|
<dt class="dlterm">CWBRC_INVALID_SYSTEM_HANDLE</dt>
|
||
|
|
<dd>Invalid system handle.</dd>
|
||
|
|
<dt class="dlterm">CWBRC_REJECTED_USER_EXIT</dt>
|
||
|
|
<dd>Command rejected by user exit program.</dd>
|
||
|
|
<dt class="dlterm">CWBRC_USR_EXIT_ERROR</dt>
|
||
|
|
<dd>Error in user exit program.</dd>
|
||
|
|
<dt class="dlterm">CWBRC_COMMAND_FAILED</dt>
|
||
|
|
<dd>Command failed.</dd>
|
||
|
|
<dt class="dlterm">CWBRC_COMMAND_TOO_LONG</dt>
|
||
|
|
<dd>Command string is too long.</dd>
|
||
|
|
<dt class="dlterm">CWB_NOT_ENOUGH_MEMORY</dt>
|
||
|
|
<dd>Insufficient memory; may have failed to allocate temporary buffer.</dd>
|
||
|
|
<dt class="dlterm">CWB_NON_REPRESENTABLE_UNICODE_CHAR</dt>
|
||
|
|
<dd>One or more input Unicode characters have no representation in the codepage
|
||
|
|
being used.</dd>
|
||
|
|
<dt class="dlterm">CWB_API_ERROR</dt>
|
||
|
|
<dd>General API failure.</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="rzaikrcdpcapilist2.htm" title="Use these APIs to run an iSeries command. The APIs are listed alphabetically.">Remote Command/Distributed Program Call: Run APIs list for iSeries Access for Windows</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|