1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>DWCGdbSearchCond</title>
9<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">
15<a name=""></a> DWCGdbSearchCond
16</h1>
17<h2>Definition</h2>
18
19<dl>
20  <dd>
21<PRE><code>
22#include &lt;dwc.h&gt;
23
24typedef struct DWCGdbSearchCond {
25    char * filter;
26    char * sort;
27    int offset;
28    int max;
29    char * target_filter;
30    int surrounding_num;
31    int * ownerids;
32    int ownerid_num;
33    BOOL cache_flag;
34} DWCGdbSearchCond;</code></PRE></dd>
35</dl>
36<H2>Description</H2>
37<p></p><TABLE border="1" width="100%">
38  <TBODY>
39
40    <TR>
41<TD width="13%"><EM><STRONG>filter</STRONG></EM></TD>
42<TD width="87%">Works the same way as SQL's <CODE>WHERE</CODE> phrase. If set to <CODE>NULL</CODE>, this argument does not specify anything.</TD>
43    </TR>
44
45    <TR>
46<TD width="13%"><EM><STRONG>sort</STRONG></EM></TD>
47<TD width="87%">Works the same way as SQL's <CODE>ORDERBY</CODE> phrase. If set to <CODE>NULL</CODE>, this argument does not specify anything.</TD>
48    </TR>
49
50    <TR>
51<TD width="13%"><EM><STRONG>offset</STRONG></EM></TD>
52<TD width="87%">Specifies the <EM>n</EM>th search result as the start for obtaining search results.</TD>
53    </TR>
54
55    <TR>
56<TD width="13%"><EM><STRONG>max</STRONG></EM></TD>
57<TD width="87%">Specifies the maximum number of search results to be obtained.</TD>
58    </TR>
59
60    <TR>
61<TD width="13%"><EM><STRONG>target_filter</STRONG></EM></TD>
62<TD width="87%">To obtain neighboring records using <CODE>surrounding_num</CODE>, set this filter to search for only one record.  If you will not be using this argument, set it to <CODE>NULL</CODE>.</TD>
63    </TR>
64
65    <TR>
66<TD width="13%"><EM><STRONG>surrounding_num</STRONG></EM></TD>
67<TD width="87%">Use this in combination with <CODE>target_filter</CODE>. Specify a value of 1 or greater to get the specified number of records above and below the search result, in addition to the search result itself.</TD>
68    </TR>
69
70    <TR>
71<TD width="13%"><EM><STRONG>ownerids</STRONG></EM></TD>
72<TD width="87%">Specifies an array of the profile IDs of the creators of records to search. If <CODE>ownerid_num</CODE> has been set to 0, you can set this argument to <CODE>NULL</CODE>.</TD>
73    </TR>
74
75    <TR>
76<TD width="13%"><EM><STRONG>ownerid_num</STRONG></EM></TD>
77<TD width="87%">Specifies the length of the array specified in <CODE>ownerids</CODE>. If you will not be using this argument, set it to 0.</TD>
78    </TR>
79
80    <TR>
81<TD width="13%"><EM><STRONG>cache_flag</STRONG></EM></TD>
82<TD width="87%">Specifies whether or not to cache the search results on the server.</TD>
83    </TR>
84
85  </TBODY>
86</TABLE>
87
88<H2>Revision History</H2>
89<DL>
90
91</DL>
92<hr><p>CONFIDENTIAL</p></body>
93</html>
94