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

<!-- $XConsortium: MmdbGBLs.sgm /main/6 1996/09/08 20:06:49 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.DtMmdbGetBookCaseByLocs">]]><refmeta><refentrytitle>
DtMmdbGetBookCaseByLocs</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
<refname><function>DtMmdbGetBookCaseByLocs</function></refname><refpurpose>obtains
descriptors for a set of bookcases based on hypertext link targets
</refpurpose></refnamediv><refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;DtMmdb.h></funcsynopsisinfo>
<funcdef>int <function>DtMmdbGetBookCaseByLocs</function></funcdef>
<paramdef>int <parameter>infolib_descriptor</parameter></paramdef>
<paramdef>const char** <parameter>locators</parameter></paramdef>
</funcsynopsis>
</refsynopsisdiv><refsect1>
<title>DESCRIPTION</title>
<para>The <function>DtMmdbGetBookCaseByLocs</function> function
makes the database engine ready to provide access service for
a set of bookcases. It allows you to access multiple bookcases by
specifying hypertext link targets that occur within the bookcases.
Use the <function>free</function> function to release the
array of bookcase descriptors
when it is no longer needed.</para>
</refsect1><refsect1>
<title>ARGUMENTS</title>
<variablelist>
<varlistentry><term><symbol role="Variable">infolib_path</symbol></term>
<listitem>
<para>Specifies the infolib that contains the bookcase.</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">locators</symbol></term>
<listitem>
<para>Specifies a zero-terminated array of locators of hypertext link
targets. Each target can be a section or a
component within a section.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1>
<title>RETURN VALUE</title>
<para>If <function>DtMmdbGetBookCaseByLocs</function> completes
successfully, it returns a pointer to a NULL-terminated array
of bookcase descriptors. If it fails, it returns NULL.
</para>
</refsect1><refsect1>
<title>EXAMPLE</title>
<para>The following shows how a <function>DtMmdbGetBookCaseByLocs</function> call
might be coded.</para>
<informalexample>
<programlisting>char locs[] = {"abcde0123456789", "fghij0123456789", 0 };
int* descriptor_array = DtMmdbGetBookCaseByLocs(myInfoLibDescriptor,  locs);
</programlisting>
</informalexample>
</refsect1><refsect1>
<title>SEE ALSO</title>
<para>&cdeman.DtMmdbGetBookCaseByIndex;,
&cdeman.DtMmdbGetBookCaseByLoc;,
&cdeman.DtMmdbGetBookCaseByName;
</para>
</refsect1></refentry>