60 lines
2.2 KiB
Plaintext
60 lines
2.2 KiB
Plaintext
<!-- $XConsortium: MmdbBCGI.sgm /main/6 1996/09/08 20:05:08 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.DtMmdbBookCaseGetInfo">]]><refmeta><refentrytitle>
|
|
DtMmdbBookCaseGetInfo</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
|
<refname><function>DtMmdbBookCaseGetInfo</function></refname><refpurpose>obtains
|
|
information about a bookcase</refpurpose></refnamediv><refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
|
<funcdef>DtMmdbBookCaseInfo* <function>DtMmdbBookCaseGetInfo</function></funcdef>
|
|
<paramdef>int <parameter>bookcase_descriptor</parameter></paramdef>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv><refsect1>
|
|
<title>DESCRIPTION</title>
|
|
<para>The <function>DtMmdbBookCaseGetInfo</function> function returns a structure
|
|
containing information about the specified bookcase.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>ARGUMENTS</title>
|
|
<variablelist>
|
|
<varlistentry><term><symbol role="Variable">bookcase_descriptor</symbol></term>
|
|
<listitem>
|
|
<para>Specifies the descriptor for the bookcase.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1><refsect1>
|
|
<title>RETURN VALUE</title>
|
|
<para>If <function>DtMmdbBookCaseGetInfo</function> completes
|
|
successfully, it return the information structure for the bookcase.
|
|
If it fails, it returns NULL.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>EXAMPLE</title>
|
|
<para>The following shows how a <function>DtMmdbBookCaseGetInfo</function> call
|
|
might be coded.</para>
|
|
<informalexample>
|
|
<programlisting>int i;
|
|
DtMmdbInfoLib* infolibInfo = DtMmdbInfoLibGetInfo(0);
|
|
DtMmdbBookCaseInfo* x;
|
|
for (i=0; i<infolibInfo->num_bookcases; i++)
|
|
{
|
|
x = DtMmdbBookCaseGetInfo(i);
|
|
/* make use of x */
|
|
}
|
|
</programlisting>
|
|
</informalexample>
|
|
</refsect1><refsect1>
|
|
<title>SEE ALSO</title>
|
|
<para>&cdeman.DtMmdbBookCaseFreeInfo;,
|
|
&cdeman.DtMmdbBookCaseGetInfo;
|
|
</para>
|
|
</refsect1></refentry>
|