89 lines
4.7 KiB
HTML
89 lines
4.7 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="cwbOBJ_GetParameter" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikobjapilist3.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="cwbobj_getparameter" />
|
||
|
|
<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>cwbOBJ_GetParameter</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbobj_getparameter"><a name="cwbobj_getparameter"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1"><span class="apiname">cwbOBJ_GetParameter</span></h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Gets the value of a parameter in a parameter
|
||
|
|
list object.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
||
|
|
unsigned int CWB_ENTRY cwbOBJ_GetParameter(
|
||
|
|
cwbOBJ_ParmHandle parmListHandle,
|
||
|
|
cwbOBJ_KeyID key,
|
||
|
|
void *buffer,
|
||
|
|
unsigned long bufLen,
|
||
|
|
unsigned long *bytesNeeded,
|
||
|
|
cwbOBJ_DataType *keyType,
|
||
|
|
cwbSV_ErrHandle errorHandle);</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">cwbOBJ_ParmHandle parmListHandle - input</dt>
|
||
|
|
<dd>Handle of the parameter object.</dd>
|
||
|
|
<dt class="dlterm">cwbOBJ_KeyID key - input</dt>
|
||
|
|
<dd>The id of the parameter to set.</dd>
|
||
|
|
<dt class="dlterm">void *buffer - output</dt>
|
||
|
|
<dd>The buffer that will hold the attribute value. If this call returns successfully.
|
||
|
|
The value of the key determines what type of data will be put into pBuffer.
|
||
|
|
The type is also returned to the *keyType parameter, if provided.</dd>
|
||
|
|
<dt class="dlterm">unsigned long bufLen - input</dt>
|
||
|
|
<dd>The length of the buffer pointed to by buffer.</dd>
|
||
|
|
<dt class="dlterm">unsigned long *bytesNeeded - output</dt>
|
||
|
|
<dd>On output, this will be the number of bytes needed to hold result.</dd>
|
||
|
|
<dt class="dlterm">cwbOBJ_DataType *keyType - output</dt>
|
||
|
|
<dd>Optional, may be NULL. On output this will contain the type of data used
|
||
|
|
to represent this attribute and what is stored at *buffer.</dd>
|
||
|
|
<dt class="dlterm">cwbSV_ErrHandle errorHandle - output</dt>
|
||
|
|
<dd>Optional, may be 0. Any returned messages 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_GetErrText()</span> API.
|
||
|
|
If the parameter is set to zero, no messages will be retrievable.</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_NOT_ENOUGH_MEMORY</dt>
|
||
|
|
<dd>Insufficient memory.</dd>
|
||
|
|
<dt class="dlterm">CWB_INVALID_HANDLE</dt>
|
||
|
|
<dd>Handle is not an allocated object handle.</dd>
|
||
|
|
<dt class="dlterm">CWB_BUFFER_OVERFLOW</dt>
|
||
|
|
<dd>Buffer too small.</dd>
|
||
|
|
<dt class="dlterm">CWBOBJ_RC_KEY_NOT_FOUND</dt>
|
||
|
|
<dd>Key isn't specified in parameter list.</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="rzaikobjapilist3.htm" title="The following iSeries Access for Windows APIs pertain to Parameter objects. The APIs are listed alphabetically.">Parameter object APIs for iSeries Access for Windows</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|