67 lines
2.7 KiB
Plaintext
67 lines
2.7 KiB
Plaintext
<!-- $XConsortium: MmdbGBBL.sgm /main/6 1996/09/08 20:06:32 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.DtMmdbGetBookCaseByLoc">]]><refmeta><refentrytitle>
|
|
DtMmdbGetBookCaseByLoc</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
|
<refname><function>DtMmdbGetBookCaseByLoc</function></refname><refpurpose>obtains
|
|
a descriptor for a bookcase based on a hypertext link target
|
|
</refpurpose></refnamediv><refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
|
<funcdef>int <function>DtMmdbGetBookCaseByLoc</function></funcdef>
|
|
<paramdef>int <parameter>infolib_path</parameter></paramdef>
|
|
<paramdef>const char* <parameter>locator</parameter></paramdef>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv><refsect1>
|
|
<title>DESCRIPTION</title>
|
|
<para>The <function>DtMmdbGetBookCaseByLoc</function> function
|
|
makes the database engine ready to provide access service for
|
|
a bookcase. It allows you to access a bookcase by using
|
|
a hypertext link target in the bookcase.
|
|
</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">locator</symbol></term>
|
|
<listitem>
|
|
<para>Specifies the locator of a hypertext link target in the bookcase.
|
|
The target can be a section or a component within a section.
|
|
The locator serves as the logical identifier of the object.
|
|
It is not generated by the DtInfo Database Engine.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1><refsect1>
|
|
<title>RETURN VALUE</title>
|
|
<para>If <function>DtMmdbGetBookCaseByLoc</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 that contains the specified target.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>EXAMPLE</title>
|
|
<para>The following shows how a <function>DtMmdbGetBookCaseByLoc</function> call
|
|
might be coded.</para>
|
|
<informalexample>
|
|
<programlisting>DtMmdbGetBookCaseByLoc(myInfoLibDescriptor, "abcde0123456789");
|
|
</programlisting>
|
|
</informalexample>
|
|
</refsect1><refsect1>
|
|
<title>SEE ALSO</title>
|
|
<para>&cdeman.DtMmdbGetBookCaseByIndex;,
|
|
&cdeman.DtMmdbGetBookCaseByLocs;,
|
|
&cdeman.DtMmdbGetBookCaseByName;
|
|
</para>
|
|
</refsect1></refentry>
|