CDE/cde/doc/C/guides/man/m3_Dt/MmdbGBBN.sgm

<!-- $XConsortium: MmdbGBBN.sgm /main/6 1996/09/08 20:06:41 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.DtMmdbGetBookCaseByName">]]><refmeta><refentrytitle>
DtMmdbGetBookCaseByName</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
<refname><function>DtMmdbGetBookCaseByName</function></refname><refpurpose>
obtains a descriptor for a bookcase based on the bookcase name
</refpurpose></refnamediv><refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;DtMmdb.h></funcsynopsisinfo>
<funcdef>int <function>DtMmdbGetBookCaseByName</function></funcdef>
<paramdef>int <parameter>infolib_descriptor</parameter></paramdef>
<paramdef>const char* <parameter>base_name</parameter></paramdef>
</funcsynopsis>
</refsynopsisdiv><refsect1>
<title>DESCRIPTION</title>
<para>The <function>DtMmdbGetBookCaseByName</function> function
makes the database engine ready to provide access service for
a bookcase. It allows you to access a bookcase by supplying
its name.
</para>
</refsect1><refsect1>
<title>ARGUMENTS</title>
<variablelist>
<varlistentry><term><symbol role="Variable">infolib_descriptor</symbol></term>
<listitem>
<para>Specifies the infolib that contains the bookcase.</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">base_name</symbol></term>
<listitem>
<para>Specifies the name of the bookcase.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1>
<title>RETURN VALUE</title>
<para>If <function>DtMmdbGetBookCaseByName</function> completes
successfully, it returns the descriptor for the bookcase.
If it fails, it returns -1, indicating that there is
no bookcase in the infolib with the specified name.
</para>
</refsect1><refsect1>
<title>EXAMPLE</title>
<para>The following shows how a <function>DtMmdbGetBookCaseByName</function> call
might be coded.</para>
<informalexample>
<programlisting>DtMmdbGetBookCaseByName(myInfoLib, "thisBookCase");
</programlisting>
</informalexample>
</refsect1><refsect1>
<title>SEE ALSO</title>
<para>&cdeman.DtMmdbGetBookCaseByIndex;,
&cdeman.DtMmdbGetBookCaseByLoc;,
&cdeman.DtMmdbGetBookCaseByLocs;
</para>
</refsect1></refentry>