<?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_SetParm" />
<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_setparm" />
<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_SetParm</title>
</head>
<body id="cwbrc_setparm"><a name="cwbrc_setparm"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">cwbRC_SetParm</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Set the parameter value identified by the
index. The index will range from 0 to the total number of parameters - 1.
This number can be obtained by calling the <span class="apiname">cwbRC_GetParmCount</span> API.
Note that this function is to be used to change a parameter. Use <span class="apiname">cwbRC_AddParm</span> to
create the parameter. </p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY cwbRC_SetParm(
cwbRC_PgmHandle program,
unsigned short index,
unsigned short type,
unsigned long length,
const unsigned char *parameter);</pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbRC_PgmHandle handle - 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.</dd>
<dt class="dlterm">unsigned short index - input</dt>
<dd>The number of the specific parameter in this program that should be changed.
This index is zero-based.</dd>
<dt class="dlterm">unsigned short type - input</dt>
<dd> The type of parameter this is. Use one of the defined parameter types: <ul><li>CWBRC_INPUT</li>
<li>CWBRC_OUTPUT</li>
<li>CWBRC_INOUT</li>
</ul>
If you want to automatically convert between local CCSID and host CCSID,
add the appropriate convert flag to this field with a bitwise-OR. Use one
of the defined parameter types: <ul><li>CWBRC_TEXT_CONVERT</li>
<li>CWBRC_TEXT_CONVERT_INPUT</li>
<li>CWBRC_TEXT_CONVERT_OUTPUT</li>
</ul>
The latter two are intended for use with CWBRC_INOUT when conversion
is only needed in one direction.</dd>
<dt class="dlterm">unsigned long length - input</dt>
<dd>The length of the parameter. If this is an CWBRC_OUT parameter, the length
should be the length of the buffer where the returned parameter will be
written.</dd>
<dt class="dlterm">const unsigned char * parameter - input</dt>
<dd>Pointer to a buffer that will contain the value if the type is CWBRC_INPUT
or CWBRC_INOUT, or the place where the return parameter is to be written if
the type is CWBRC_OUTPUT or CWBRC_INOUT.</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">CWBRC_INVALID_PROGRAM</dt>
<dd>Invalid program handle.</dd>
<dt class="dlterm">CWBRC_INVALID_TYPE</dt>
<dd>Invalid type specified.</dd>
<dt class="dlterm">CWBRC_INVALID_PARM_LENGTH</dt>
<dd>Invalid parameter length.</dd>
<dt class="dlterm">CWBRC_INVALID_PARM</dt>
<dd>Invalid parameter.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p>Parameter data is assumed to be binary. No
conversion will be performed on the parameter data unless one of the conversion
flags is set. For example: </p>
<pre> cwbRC_SetParm( hPgm,
CWBRC_INOUT | CWBRC_TEXT_CONVERT_OUTPUT,
bufferSize,
buffer ); </pre>
<p>will
use the buffer as is to send to the host, and will convert the output (for
example, to ASCII) before putting the result into the buffer.</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>