MmdbILGI.sgm 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. <!-- $XConsortium: MmdbILGI.sgm /main/6 1996/09/08 20:07:24 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.DtMmdbInfoLibGetInfo">]]><refmeta><refentrytitle>
  10. DtMmdbInfoLibGetInfo</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
  11. <refname><function>DtMmdbInfoLibGetInfo</function></refname><refpurpose>obtains
  12. information about an infolib</refpurpose></refnamediv><refsynopsisdiv>
  13. <funcsynopsis>
  14. <funcsynopsisinfo>#include &lt;DtMmdb.h></funcsynopsisinfo>
  15. <funcdef>DtMmdbInfoLib* <function>DtMmdbInfoLibGetInfo</function></funcdef>
  16. <paramdef>int <parameter>infolib_descriptor</parameter></paramdef>
  17. </funcsynopsis>
  18. </refsynopsisdiv><refsect1>
  19. <title>DESCRIPTION</title>
  20. <para>The <function>DtMmdbInfoLibGetInfo</function> function
  21. returns a structure containing information about a specified
  22. infolib.
  23. </para>
  24. </refsect1><refsect1>
  25. <title>ARGUMENTS</title>
  26. <variablelist>
  27. <varlistentry><term><symbol role="Variable">infolib_descriptor</symbol></term>
  28. <listitem>
  29. <para>Specifies the descriptor for the desired infolib.
  30. </para>
  31. </listitem>
  32. </varlistentry>
  33. </variablelist>
  34. </refsect1><refsect1>
  35. <title>RETURN VALUE</title>
  36. <para>If <function>DtMmdbInfoLibGetInfo</function> completes
  37. successfully, it returns a pointer to the
  38. <StructName Role="typedef">DtMmdbInfoLib</StructName>
  39. structure. If it fails, it returns a NULL pointer.
  40. </para>
  41. </refsect1><refsect1>
  42. <title>EXAMPLE</title>
  43. <para>The following shows how a <function>DtMmdbInfoLibGetInfo</function> call
  44. might be coded.</para>
  45. <informalexample>
  46. <programlisting>DtMmdbInfoLibGetInfo(i);
  47. </programlisting>
  48. </informalexample>
  49. </refsect1><refsect1>
  50. <title>SEE ALSO</title>
  51. <para>&cdeman.DtMmdbInfoLibFreeInfo;,
  52. &cdeman.DtMmdbInfoLibInfo;,
  53. &cdeman.DtMmdbOpenInfoLib;
  54. </para>
  55. </refsect1></refentry>