Peter Howkins
58 lines
2.0 KiB
Plaintext
58 lines
2.0 KiB
Plaintext
<!-- $XConsortium: dtsrsmrs.sgm 1996 -->
|
|
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
|
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
|
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
|
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
|
<!-- (c) Copyright 1995 Novell, Inc. -->
|
|
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
|
<!-- (c) Copyright 1995 Hitachi. -->
|
|
<![ %CDE.C.CDE; [<refentry id="CDE.SEARCH.DtSearchSetMaxResults">]]>
|
|
<refmeta>
|
|
<refentrytitle>DtSearchSetMaxResults</refentrytitle>
|
|
<manvolnum>library call</manvolnum>
|
|
</refmeta>
|
|
<refnamediv><refname><function>DtSearchSetMaxResults</function></refname>
|
|
<refpurpose>Set the DtSearch maximum results value
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>#include <Dt/Search.h></funcsynopsisinfo>
|
|
<funcdef>void <function>DtSearchSetMaxResults</function></funcdef>
|
|
<paramdef>int <parameter>max</parameter></paramdef>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv><refsect1>
|
|
<title>DESCRIPTION</title>
|
|
<para>The results list returned from <function>DtSearchQuery</function> will
|
|
be truncated to a maximum number of items after search completion and
|
|
statistical ranking. <function>DtSearchSetMaxResults</function> changes
|
|
the maximum results setting to <symbol role="variable">max</symbol>.
|
|
</para>
|
|
<para>If <function>DtSearchSetMaxResults</function> is never called, the
|
|
maximum number of DtSrResult items returned will default to 20.
|
|
</para>
|
|
<para>The function can be called any time after
|
|
<function>DtSearchInit()</function>.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>ARGUMENTS</title>
|
|
<variablelist>
|
|
<varlistentry><term><symbol role="Variable">max</symbol></term>
|
|
<listitem>
|
|
<para>Specifies the maximum number of items in the list returned from
|
|
<function>DtSearchQuery</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>RELATED</title>
|
|
<para>&cdeman.DtSrAPI;,
|
|
&cdeman.DtSearchGetMaxResults;,
|
|
&cdeman.DtSearchQuery;
|
|
</para>
|
|
</refsect1></refentry>
|
|
|
|
|