86 lines
4.8 KiB
HTML
86 lines
4.8 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="CWBSO_SetListFilter" />
|
|
<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="cwbsosl" />
|
|
<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_SetListFilter</title>
|
|
</head>
|
|
<body id="cwbsosl"><a name="cwbsosl"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1"><span class="apiname">CWBSO_SetListFilter</span></h1>
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4><p>Sets a filter value for a list. Depending
|
|
on the type of list, various filter values may be set. The filter values
|
|
control which objects will be included in the list when the list is built
|
|
by a call to <span class="apiname">CWBSO_OpenList</span>.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>
|
|
unsigned int CWB_ENTRY CWBSO_SetListFilter(
|
|
CWBSO_LIST_HANDLE listHandle,
|
|
unsigned short usFilterID,
|
|
char far* lpszValue); </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 short usFilterID - input</dt>
|
|
<dd>The filter identifier specifies which portion of the filter to set. The
|
|
valid values for this parameter depend on the type of objects in the list.
|
|
See the appropriate header files for the valid values: <ul><li>cwbsojob.h</li>
|
|
<li>cwbsomsg.h</li>
|
|
<li>cwbsoprt.h</li>
|
|
<li>cwbsosfl.h</li>
|
|
</ul>
|
|
</dd>
|
|
<dt class="dlterm">char far* lpszValue - input</dt>
|
|
<dd>The value for the filter attribute. If multiple items are specified,
|
|
they must be separated by commas. Filter value items that specify iSeries™ object
|
|
names must be in uppercase. Qualified object names must be in the form of
|
|
library/object. Qualified job names must be in the form of job-number/user/job-name.
|
|
Filter value items specifying special values (beginning with asterisk) must
|
|
be specified in upper case. See <a href="rzaiksoaattrspecvalu.htm#soaattrspecvalu">SOA attribute special values</a> for
|
|
information on the special values that may be supplied for each type of object.</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_FILTER_ID</dt>
|
|
<dd>The filter ID specified is not valid for the type of list.</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. This API has no effect on a list that has
|
|
been opened. In order for the filter criteria to take effect, the list must
|
|
be opened after calling this API. Caution should be used when requesting complex
|
|
filters as list performance may be adversely affected.</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> |