MmdbBCFI.sgm 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. <!-- $XConsortium: MmdbBCFI.sgm /main/6 1996/09/08 20:05:00 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.DtMmdbBookCaseFreeInfo">]]><refmeta><refentrytitle>
  10. DtMmdbBookCaseFreeInfo</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
  11. <refname><function>DtMmdbBookCaseFreeInfo</function></refname><refpurpose>frees space
  12. used by bookcase information structure
  13. </refpurpose></refnamediv><refsynopsisdiv>
  14. <funcsynopsis>
  15. <funcsynopsisinfo>#include &lt;DtMmdb.h></funcsynopsisinfo>
  16. <funcdef>void <function>DtMmdbBookCaseFreeInfo</function></funcdef>
  17. <paramdef>DtMmdbBookCaseInfo* <parameter>x</parameter></paramdef>
  18. </funcsynopsis>
  19. </refsynopsisdiv><refsect1>
  20. <title>DESCRIPTION</title>
  21. <para>The <function>DtMmdbBookCaseFreeInfo</function> function
  22. frees the space used by the specified bookcase information
  23. structure.
  24. </para>
  25. </refsect1><refsect1>
  26. <title>ARGUMENTS</title>
  27. <variablelist>
  28. <varlistentry><term><symbol role="Variable">x</symbol></term>
  29. <listitem>
  30. <para>Specifies a pointer to the bookcase information structure.
  31. </para>
  32. </listitem>
  33. </varlistentry>
  34. </variablelist>
  35. </refsect1>
  36. <refsect1>
  37. <title>RETURN VALUE</title>
  38. <para>None.</para>
  39. </refsect1>
  40. <refsect1>
  41. <title>EXAMPLE</title>
  42. <para>The following shows how a <function>DtMmdbBookCaseFreeInfo</function> call
  43. might be coded.</para>
  44. <informalexample>
  45. <programlisting>DtBookCaseInfo* x = DtMmdbBookCaseGetInfo(0);
  46. /* make use of x */
  47. DtMmdbBookCaseFreeInfo(x);
  48. /* free x */
  49. </programlisting>
  50. </informalexample>
  51. </refsect1><refsect1>
  52. <title>SEE ALSO</title>
  53. <para>&cdeman.DtMmdbBookCaseGetInfo;,
  54. &cdeman.DtMmdbBookCaseGetInfo;
  55. </para>
  56. </refsect1></refentry>