195 lines
12 KiB
HTML
195 lines
12 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="System Object Access APIs for iSeries Access for Windows List" />
|
||
|
|
<meta name="abstract" content="The following System Object Access APIs for iSeries Access for Windows are listed alphabetically." />
|
||
|
|
<meta name="description" content="The following System Object Access APIs for iSeries Access for Windows are listed alphabetically." />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksoa.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsocloselist.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsocopyobjhandle.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsocreateerrorhandle.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsocreatelisthandle.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsocreatelisthandleex.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsocreateobjhandle.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsocreateparmobjhand.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsodeleteerrorhandle.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsodeletelisthandle.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsodeleteobjhandle.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsodeleteparmobjhand.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsodisallowlistactio.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsodisallowlistfilte.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsod3.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsodisplaylist.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsodisplayobjattr.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsogeterrmsgtext.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsogetlistsize.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsogo.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsogetobjhandle.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsoopenlist.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsoreadlistprofile.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsorefreshobj.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsoresetparmobj.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsosl.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsosetlistprofile.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsosetlistsortfields.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsosetlisttitle.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsoso.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsosetparameter.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsowaitforobj.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaikcwbsowritelistprofile.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksoaattrspecvalu.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="soaapilist" />
|
||
|
|
<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>System Object Access APIs for iSeries Access for Windows List</title>
|
||
|
|
</head>
|
||
|
|
<body id="soaapilist"><a name="soaapilist"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">System Object Access APIs for <span class="keyword">iSeries Access for Windows</span> List</h1>
|
||
|
|
<div><p>The following System Object Access APIs for <span class="keyword">iSeries™ Access for Windows<sup>®</sup></span> are
|
||
|
|
listed alphabetically.</p>
|
||
|
|
<div class="section"><h4 class="sectiontitle">SOA enablers:</h4> <p>System Object Access also includes
|
||
|
|
enablers (APIs), which applications can use to access data in iSeries objects
|
||
|
|
or to request graphical lists and attribute views of the object data. The
|
||
|
|
APIs for manipulating lists of objects must be called in the correct order.
|
||
|
|
The basic flow is as follows: </p>
|
||
|
|
<pre>CreateErrorHandle -- Creates a handle to an "error" object
|
||
|
|
to be passed to other APIs
|
||
|
|
CreateListHandle -- Instantiates a list object on the client
|
||
|
|
OpenList -- Builds list on iSeries server associated with client
|
||
|
|
list
|
||
|
|
(Manipulate the list and its objects using various generic
|
||
|
|
and subclass APIs)
|
||
|
|
CloseList -- Closes list and release resource on iSeries server
|
||
|
|
DeleteListHandle -- Destroys list object on the client</pre>
|
||
|
|
<p>The <span class="apiname">CWBSO_CreateListHandle</span> API
|
||
|
|
must be called to create a list before any other list APIs are called. The <span class="apiname">CWBSO_CreateListHandle</span> API
|
||
|
|
returns a list handle to the caller. The list handle must be passed as input
|
||
|
|
to all other list APIs.</p>
|
||
|
|
<p>After the list is allocated, the <span class="apiname">CWBSO_SetListFilter</span> API
|
||
|
|
can be called to change the filter criteria for the list. <span class="apiname">CWBSO_SetListFilter</span> is
|
||
|
|
optional; if it is not called, the list will be built with the default filter
|
||
|
|
criteria. Similarly, the <span class="apiname">CWBSO_SetListSortFields</span> API can
|
||
|
|
be called to define the attributes on which the list will be sorted. If it
|
||
|
|
is not called the list will not be sorted.</p>
|
||
|
|
<p>The <span class="apiname">CWBSO_OpenList</span> API
|
||
|
|
must be called to build the list of objects. This will result in a request
|
||
|
|
to be sent to the iSeries server. The list will be built on the iSeries server,
|
||
|
|
and some or all of the objects (records) in the list will be buffered down
|
||
|
|
to the list on the client. Although all objects in the list are not necessarily
|
||
|
|
cached on the client, the APIs will behave as if they are. Once the <span class="apiname">CWBSO_OpenList</span> API
|
||
|
|
is called successfully, the following APIs can be called: </p>
|
||
|
|
<dl><dt class="dlterm"><span><span class="apiname">CWBSO_GetObjHandle</span></span></dt>
|
||
|
|
<dd>Retrieves a handle to a specific object in the list. The object handle
|
||
|
|
can then be used to manipulate the specific object.</dd>
|
||
|
|
<dt class="dlterm"><span><span class="apiname">CWBSO_DeleteObjHandle</span></span></dt>
|
||
|
|
<dd> Releases the handle returned by <span class="apiname">CWBSO_GetObjHandle</span>.</dd>
|
||
|
|
<dt class="dlterm"><span><span class="apiname">CWBSO_DisplayList</span></span></dt>
|
||
|
|
<dd> Displays the spreadsheet view of the list.</dd>
|
||
|
|
<dt class="dlterm"><span><span class="apiname">CWBSO_GetListSize</span></span></dt>
|
||
|
|
<dd>Retrieves the number of objects in the list.</dd>
|
||
|
|
<dt class="dlterm"><span><span class="apiname">CWBSO_CloseList</span></span></dt>
|
||
|
|
<dd>Closes the list on the iSeries server and destroy all client objects in
|
||
|
|
the list. All object handles returned by <span class="apiname">CWBSO_GetListObject</span> no
|
||
|
|
longer are valid after the list is closed. After the list is closed, the APIs
|
||
|
|
in this list cannot be called until the <span class="apiname">CWBSO_OpenList</span> API
|
||
|
|
is called again. The <span class="apiname">CWBSO_DeleteListHandle</span> API should
|
||
|
|
be called to destroy the list object.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<ul class="ullinks">
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsocloselist.htm">CWBSO_CloseList</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsocopyobjhandle.htm">CWBSO_CopyObjHandle</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsocreateerrorhandle.htm">CWBSO_CreateErrorHandle</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsocreatelisthandle.htm">CWBSO_CreateListHandle</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsocreatelisthandleex.htm">CWBSO_CreateListHandleEx</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsocreateobjhandle.htm">CWBSO_CreateObjHandle</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsocreateparmobjhand.htm">CWBSO_CreateParmObjHandle</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsodeleteerrorhandle.htm">CWBSO_DeleteErrorHandle</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsodeletelisthandle.htm">CWBSO_DeleteListHandle</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsodeleteobjhandle.htm">CWBSO_DeleteObjHandle</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsodeleteparmobjhand.htm">CWBSO_DeleteParmObjHandle</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsodisallowlistactio.htm">CWBSO_DisallowListActions</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsodisallowlistfilte.htm">CWBSO_DisallowListFilter</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsod3.htm">CWBSO_DisplayErrMsg</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsodisplaylist.htm">CWBSO_DisplayList</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsodisplayobjattr.htm">CWBSO_DisplayObjAttr</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsogeterrmsgtext.htm">CWBSO_GetErrMsgText</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsogetlistsize.htm">CWBSO_GetListSize</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsogo.htm">CWBSO_GetObjAttr</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsogetobjhandle.htm">CWBSO_GetObjHandle</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsoopenlist.htm">CWBSO_OpenList</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsoreadlistprofile.htm">CWBSO_ReadListProfile</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsorefreshobj.htm">CWBSO_RefreshObj</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsoresetparmobj.htm">CWBSO_ResetParmObj</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsosl.htm">CWBSO_SetListFilter</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsosetlistprofile.htm">CWBSO_SetListProfile</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsosetlistsortfields.htm">CWBSO_SetListSortFields</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsosetlisttitle.htm">CWBSO_SetListTitle</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsoso.htm">CWBSO_SetObjAttr</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsosetparameter.htm">CWBSO_SetParameter</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsowaitforobj.htm">CWBSO_WaitForObj</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaikcwbsowritelistprofile.htm">CWBSO_WriteListProfile</a></strong><br />
|
||
|
|
</li>
|
||
|
|
<li class="ulchildlink"><strong><a href="rzaiksoaattrspecvalu.htm">SOA attribute special values</a></strong><br />
|
||
|
|
The topics that are listed below provide a description of special
|
||
|
|
values that may be returned by <span class="apiname">CWBSO_GetObjAttr</span>, and specified
|
||
|
|
on <span class="apiname">CWBSO_SetObjAttr</span>, for each type of object. In addition,
|
||
|
|
any special values that may be specified on <span class="apiname">CWBSO_SetListFilter</span> for
|
||
|
|
each type of list object are discussed.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksoa.htm" title="System Object Access enables you to view and manipulate iSeries objects through a graphical user interface.">iSeries Access for Windows System Object Access (SOA) APIs</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|