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

81 lines
4.3 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_CreatePgm" />
<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_createpgm" />
<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_CreatePgm</title>
</head>
<body id="cwbrc_createpgm"><a name="cwbrc_createpgm"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbRC_CreatePgm</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p> This function creates a program object
given a program and library name. The handle that is returned can be used
to add parameters to the program and then call the program.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY cwbRC_CreatePgm(
const char *programName,
const char *libraryName,
cwbRC_PgmHandle *program);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">const char *programName - input</dt>
<dd>Pointer to an ASCIIZ string that contains the name of the program that
you want to call. The name is uppercased unless enclosed in double quotes. </dd>
<dt class="dlterm">const char *libraryName - input</dt>
<dd>Pointer to an ASCIIZ string that contains the name of the library where
the program resides. The name is uppercased unless enclosed in double quotes.</dd>
<dt class="dlterm">cwbRC_PgmHandle * program - output</dt>
<dd>Pointer to a <span class="apiname">cwbRC_PgmHandle</span> where the handle of the
program 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_INVALID_POINTER</dt>
<dd>Bad or NULL pointer.</dd>
<dt class="dlterm">CWBRC_PROGRAM_NAME</dt>
<dd>Program name is too long.</dd>
<dt class="dlterm">CWBRC_LIBRARY_NAME</dt>
<dd>Library 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>You should create a separate program object
for each program you want to call on the iSeries™ server. You can use the functions
described in this file to change the values of the parameters being sent to
the program, but cannot change the number of parameters being sent.</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>