MmdbFrHL.sgm 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. <!-- $XConsortium: MmdbFrHL.sgm /main/7 1996/09/08 20:06:07 rws $ -->
  2. <!-- (c) Copyright 1996 Digital Equipment Corporation. -->
  3. <!-- (c) Copyright 1996 Hewlett-Packard Company. -->
  4. <!-- (c) Copyright 1996 International Business Machines Corp. -->
  5. <!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
  6. <!-- (c) Copyright 1996 Novell, Inc. -->
  7. <!-- (c) Copyright 1996 FUJITSU LIMITED. -->
  8. <!-- (c) Copyright 1996 Hitachi. -->
  9. <![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbFreeHandleList">]]><refmeta><refentrytitle>
  10. DtMmdbFreeHandleList</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
  11. <refname><function>DtMmdbFreeHandleList</function></refname><refpurpose>
  12. frees memory used by a
  13. <Symbol>DtMmdbHandle</Symbol> array
  14. </refpurpose></refnamediv><refsynopsisdiv>
  15. <funcsynopsis>
  16. <funcsynopsisinfo>#include &lt;DtMmdb.h></funcsynopsisinfo>
  17. <funcdef>void <function>DtMmdbFreeHandleList</function></funcdef>
  18. <paramdef>DtMmdbHandle** <parameter>list</parameter></paramdef>
  19. </funcsynopsis>
  20. </refsynopsisdiv><refsect1>
  21. <title>DESCRIPTION</title>
  22. <para>The <function>DtMmdbFreeHandleList</function>
  23. frees all memory used by a
  24. <Symbol>DtMmdbHandle</Symbol> array,
  25. including all contained <StructName Role="typedef">DtMmdbHandle</StructName>
  26. structures.
  27. </para>
  28. </refsect1><refsect1>
  29. <title>ARGUMENTS</title>
  30. <variablelist>
  31. <varlistentry><term><symbol role="Variable">list</symbol></term>
  32. <listitem>
  33. <para>Specifies the pointer to the
  34. <Symbol>DtMmdbHandle</Symbol> array.</para>
  35. </listitem>
  36. </varlistentry>
  37. </variablelist>
  38. </refsect1><refsect1>
  39. <title>RETURN VALUE</title>
  40. <para>None.
  41. </para>
  42. </refsect1><refsect1>
  43. <title>EXAMPLE</title>
  44. <para>The following shows how a <function>DtMmdbFreeHandleList</function> call
  45. might be coded.</para>
  46. <informalexample>
  47. <programlisting>DtMmdbHandle** x = ...
  48. /* make use of x */
  49. DtMmdbFreeHandleList(x); /* free x */
  50. </programlisting>
  51. </informalexample>
  52. </refsect1><refsect1>
  53. <title>SEE ALSO</title>
  54. <para>&cdeman.DtMmdbFreeHandle;</para>
  55. </refsect1></refentry>