90 lines
4.8 KiB
HTML
90 lines
4.8 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_StartSysEx" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikrcdpcapilist1.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_startsysex" />
|
||
|
|
<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_StartSysEx</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbrc_startsysex"><a name="cwbrc_startsysex"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbRC_StartSysEx</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>This function starts a conversation with
|
||
|
|
the specified system. If the conversation is successfully started, a handle
|
||
|
|
is returned. Use this handle with all subsequent calls to issue commands or
|
||
|
|
call programs. When the conversation no longer is needed, use the handle with
|
||
|
|
the <span class="apiname">cwbRC_StopSys</span> API to end the conversation. The <span class="apiname">cwbRC_StartSysEx</span> API
|
||
|
|
may be called multiple times within an application. If the same system object
|
||
|
|
handle is used on StartSysEx calls, only one conversation with the iSeries™ server
|
||
|
|
will be started. If you want multiple conversations to be active, you must
|
||
|
|
call StartSysEx multiple times, specifying different system object handles.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
unsigned int CWB_ENTRY cwbRC_StartSysEx(
|
||
|
|
const cwbCO_SysHandle systemObj,
|
||
|
|
cwbRC_SysHandle *request);</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">const cwbCO_SysHandle systemObj - input</dt>
|
||
|
|
<dd>Handle to an existing system object of the system on which you want programs
|
||
|
|
and commands to be run.</dd>
|
||
|
|
<dt class="dlterm">cwbRC_SysHandle *request - output</dt>
|
||
|
|
<dd>Pointer to a <span class="apiname">cwbRC_SysHandle</span> where the handle of the
|
||
|
|
command request will be returned.</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">CWB_SERVER_PROGRAM_NOT_FOUND</dt>
|
||
|
|
<dd>iSeries application
|
||
|
|
not found.</dd>
|
||
|
|
<dt class="dlterm">CWB_HOST_NOT_FOUND</dt>
|
||
|
|
<dd>iSeries system
|
||
|
|
inactive or does not exist.</dd>
|
||
|
|
<dt class="dlterm">CWB_SECURITY_ERROR</dt>
|
||
|
|
<dd>A security error has occurred.</dd>
|
||
|
|
<dt class="dlterm">CWB_LICENSE_ERROR</dt>
|
||
|
|
<dd>A license error has occurred.</dd>
|
||
|
|
<dt class="dlterm">CWB_CONFIG_ERROR</dt>
|
||
|
|
<dd>A configuration error has occurred.</dd>
|
||
|
|
<dt class="dlterm">CWBRC_SYSTEM_NAME</dt>
|
||
|
|
<dd>System name 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="rzaikrcdpcapilist1.htm" title="Access the remote command server program on the iSeries system. The request handle is used to run commands and to call programs. The APIs are listed alphabetically.">Remote Command/Distributed Program Call: Access remote command APIs list for iSeries Access for Windows</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|