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

56 lines
2.1 KiB
Plaintext

<!-- $XConsortium: MmdbILGI.sgm /main/6 1996/09/08 20:07:24 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.DtMmdbInfoLibGetInfo">]]><refmeta><refentrytitle>
DtMmdbInfoLibGetInfo</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
<refname><function>DtMmdbInfoLibGetInfo</function></refname><refpurpose>obtains
information about an infolib</refpurpose></refnamediv><refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;DtMmdb.h></funcsynopsisinfo>
<funcdef>DtMmdbInfoLib* <function>DtMmdbInfoLibGetInfo</function></funcdef>
<paramdef>int <parameter>infolib_descriptor</parameter></paramdef>
</funcsynopsis>
</refsynopsisdiv><refsect1>
<title>DESCRIPTION</title>
<para>The <function>DtMmdbInfoLibGetInfo</function> function
returns a structure containing information about a specified
infolib.
</para>
</refsect1><refsect1>
<title>ARGUMENTS</title>
<variablelist>
<varlistentry><term><symbol role="Variable">infolib_descriptor</symbol></term>
<listitem>
<para>Specifies the descriptor for the desired infolib.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1>
<title>RETURN VALUE</title>
<para>If <function>DtMmdbInfoLibGetInfo</function> completes
successfully, it returns a pointer to the
<StructName Role="typedef">DtMmdbInfoLib</StructName>
structure. If it fails, it returns a NULL pointer.
</para>
</refsect1><refsect1>
<title>EXAMPLE</title>
<para>The following shows how a <function>DtMmdbInfoLibGetInfo</function> call
might be coded.</para>
<informalexample>
<programlisting>DtMmdbInfoLibGetInfo(i);
</programlisting>
</informalexample>
</refsect1><refsect1>
<title>SEE ALSO</title>
<para>&cdeman.DtMmdbInfoLibFreeInfo;,
&cdeman.DtMmdbInfoLibInfo;,
&cdeman.DtMmdbOpenInfoLib;
</para>
</refsect1></refentry>