81 lines
4.1 KiB
HTML
81 lines
4.1 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_GetParm" />
|
|
<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_getparm" />
|
|
<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_GetParm</title>
|
|
</head>
|
|
<body id="cwbrc_getparm"><a name="cwbrc_getparm"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1"><span class="apiname">cwbRC_GetParm</span></h1>
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Retrieve the parameter 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.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
|
unsigned int CWB_ENTRY cwbRC_GetParm(
|
|
cwbRC_PgmHandle program,
|
|
unsigned short index,
|
|
unsigned short *type,
|
|
unsigned long *length,
|
|
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 retrieved.
|
|
This index is zero-based.</dd>
|
|
<dt class="dlterm">unsigned short * type - output</dt>
|
|
<dd>Pointer to the type of parameter this is. The value will be one of the
|
|
defined parameter types: <ul><li>CWBRC_INPUT</li>
|
|
<li>CWBRC_OUTPUT</li>
|
|
<li>CWBRC_INOUT</li>
|
|
</ul>
|
|
</dd>
|
|
<dt class="dlterm">unsigned long * length - input</dt>
|
|
<dd>Pointer to the length of the parameter.</dd>
|
|
<dt class="dlterm">unsigned char * * parameter - output</dt>
|
|
<dd>Pointer to a buffer that will contain the address of the actual parameter.</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_PROGRAM</dt>
|
|
<dd>Invalid program handle.</dd>
|
|
<dt class="dlterm">CWBRC_INDEX_RANGE_ERROR</dt>
|
|
<dd>Index is out of range.</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> |