Files
cdesktop/cde/doc/C/guides/man/m3_Dt/MmdbBCFI.sgm

57 lines
1.9 KiB
Plaintext

<!-- $XConsortium: MmdbBCFI.sgm /main/6 1996/09/08 20:05:00 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.DtMmdbBookCaseFreeInfo">]]><refmeta><refentrytitle>
DtMmdbBookCaseFreeInfo</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
<refname><function>DtMmdbBookCaseFreeInfo</function></refname><refpurpose>frees space
used by bookcase information structure
</refpurpose></refnamediv><refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;DtMmdb.h></funcsynopsisinfo>
<funcdef>void <function>DtMmdbBookCaseFreeInfo</function></funcdef>
<paramdef>DtMmdbBookCaseInfo* <parameter>x</parameter></paramdef>
</funcsynopsis>
</refsynopsisdiv><refsect1>
<title>DESCRIPTION</title>
<para>The <function>DtMmdbBookCaseFreeInfo</function> function
frees the space used by the specified bookcase information
structure.
</para>
</refsect1><refsect1>
<title>ARGUMENTS</title>
<variablelist>
<varlistentry><term><symbol role="Variable">x</symbol></term>
<listitem>
<para>Specifies a pointer to the bookcase information structure.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>RETURN VALUE</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>EXAMPLE</title>
<para>The following shows how a <function>DtMmdbBookCaseFreeInfo</function> call
might be coded.</para>
<informalexample>
<programlisting>DtBookCaseInfo* x = DtMmdbBookCaseGetInfo(0);
/* make use of x */
DtMmdbBookCaseFreeInfo(x);
/* free x */
</programlisting>
</informalexample>
</refsect1><refsect1>
<title>SEE ALSO</title>
<para>&cdeman.DtMmdbBookCaseGetInfo;,
&cdeman.DtMmdbBookCaseGetInfo;
</para>
</refsect1></refentry>