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

78 lines
4.4 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<?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="CWBSO_WaitForObj" />
<meta name="DC.Relation" scheme="URI" content="rzaiksoaapilist.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="cwbso_waitforobj" />
<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>CWBSO_WaitForObj</title>
</head>
<body id="cwbso_waitforobj"><a name="cwbso_waitforobj"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1"><span class="apiname">CWBSO_WaitForObj</span></h1>
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Waits until an object is available in a
list that is being built asynchronously.</p>
</div>
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
unsigned int CWB_ENTRY CWBSO_WaitForObj(
CWBSO_LIST_HANDLE listHandle,
unsigned long ulPosition,
CWBSO_ERR_HANDLE errorHandle); </pre>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><dl><dt class="dlterm">CWBSO_LIST_HANDLE listHandle - input</dt>
<dd>A handle to a list that was returned by a previous call to <span class="apiname">CWBSO_CreateListHandle</span> or
<span class="apiname">CWBSO_CreateListHandleEx</span>.</dd>
<dt class="dlterm">unsigned long ulPosition - input</dt>
<dd>The position of the desired object within the list. NOTE: The first object
in a list is considered position 0.</dd>
<dt class="dlterm">CWBSO_ERR_HANDLE errorHandle - input</dt>
<dd>A handle to an error object. If an error occurs that there is error text
for, this handle may be used to retrieve the error message and message help.</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">CWBSO_NO_ERROR</dt>
<dd>No error occurred.</dd>
<dt class="dlterm">CWBSO_BAD_LIST_HANDLE</dt>
<dd>The list handle that is specified is not valid.</dd>
<dt class="dlterm">CWBSO_BAD_ERR_HANDLE</dt>
<dd>The error handle that is specified is not valid.</dd>
<dt class="dlterm">CWBSO_BAD_LIST_POSITION</dt>
<dd>The position in list that is specified does not exist.</dd>
<dt class="dlterm">CWBSO_LOW_MEMORY</dt>
<dd>Not enough memory is available for the request.</dd>
<dt class="dlterm">CWBSO_ERROR_OCCURRED</dt>
<dd>An error occurred. Use error handle for more information.</dd>
</dl>
</div>
<div class="section"><h4 class="sectiontitle">Usage</h4><p><span class="apiname">CWBSO_CreateListHandle</span> must
be called prior to calling this API. The list handle that is returned by <span class="apiname">CWBSO_CreateListHandle</span> must
be passed as input to this API. <span class="apiname">CWBSO_CreateErrorHandle</span> must
be called prior to calling this API. The error handle that is returned by <span class="apiname">CWBSO_CreateErrorHandle</span> must
be passed as input to this API.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksoaapilist.htm" title="The following System Object Access APIs for iSeries Access for Windows are listed alphabetically.">System Object Access APIs for iSeries Access for Windows List</a></div>
</div>
</div>
</body>
</html>