46 lines
1.6 KiB
Plaintext
46 lines
1.6 KiB
Plaintext
<!-- $XConsortium: dtsrgmrs.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.DtSearchGetMaxResults">]]>
|
|
<refmeta>
|
|
<refentrytitle>DtSearchGetMaxResults</refentrytitle>
|
|
<manvolnum>library call</manvolnum></refmeta>
|
|
<refnamediv>
|
|
<refname><function>DtSearchGetMaxResults</function></refname>
|
|
<refpurpose>Obtain the DtSearch maximum results value
|
|
</refpurpose></refnamediv>
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>#include <Dt/Search.h></funcsynopsisinfo>
|
|
<funcdef>int <function>DtSearchGetMaxResults</function></funcdef>
|
|
<paramdef></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>DtSearchGetMaxResults</function> returns
|
|
the current maximum results setting.
|
|
</para>
|
|
<para>The function can be called any time after <function>DtSearchInit</function>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>RETURN VALUE</title>
|
|
<para><function>DtSearchGetMaxResults</function> returns the current maximum results value.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>SEE ALSO</title>
|
|
<para>&cdeman.DtSrAPI;,
|
|
&cdeman.DtSearchSetMaxResults;,
|
|
&cdeman.DtSearchQuery;
|
|
</para>
|
|
</refsect1></refentry>
|
|
|