SrchFree.sgm 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. <!-- $XConsortium: dtsrfres.sgm 1996 -->
  2. <!-- (c) Copyright 1995 Digital Equipment Corporation. -->
  3. <!-- (c) Copyright 1995 Hewlett-Packard Company. -->
  4. <!-- (c) Copyright 1995 International Business Machines Corp. -->
  5. <!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
  6. <!-- (c) Copyright 1995 Novell, Inc. -->
  7. <!-- (c) Copyright 1995 FUJITSU LIMITED. -->
  8. <!-- (c) Copyright 1995 Hitachi. -->
  9. <![ %CDE.C.CDE; [<refentry id="CDE.SEARCHDtSearchFreeResults">]]>
  10. <refmeta><refentrytitle>DtSearchFreeResults</refentrytitle>
  11. <manvolnum>library call</manvolnum></refmeta>
  12. <refnamediv>
  13. <refname><function>DtSearchFree Results</function></refname>
  14. <refpurpose>Free storage allocated for DtSearch results
  15. lists</refpurpose>
  16. </refnamediv>
  17. <refsynopsisdiv>
  18. <funcsynopsis>
  19. <funcsynopsisinfo>#include &lt;Dt/Search.h></funcsynopsisinfo>
  20. <funcdef>int <function>DtFreeSearchResults</function></funcdef>
  21. <paramdef>DtSrResult <parameter>**list</parameter></paramdef>
  22. </funcsynopsis>
  23. </refsynopsisdiv>
  24. <refsect1>
  25. <title>DESCRIPTION</title>
  26. <para>The <function>DtFreeSearchResults</function> function frees the results
  27. list pointed to by <symbol role="Variable">list</symbol> which
  28. was originally returned from <function>DtSearchQuery</function>, and
  29. sets the <symbol role="Variable">list</symbol> pointer to NULL.
  30. </para>
  31. </refsect1><refsect1>
  32. <title>RETURNS</title>
  33. <para>Always returns <systemitem class="constant">DtSrOK</systemitem>.
  34. </para>
  35. </refsect1>
  36. <refsect1>
  37. <title>SEE ALSO</title>
  38. <para>&cdeman.DtSrAPI;,
  39. &cdeman.DtSearchQuery;,
  40. &cdeman.DtSearchSortResults;,
  41. &cdeman.DtSearchMergeResults;</para>
  42. </refsect1></refentry>