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

<!-- $XConsortium: MmdbOpIL.sgm /main/7 1996/09/08 20:07:50 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.DtMmdbOpenInfoLib">]]><refmeta><refentrytitle>
DtMmdbOpenInfoLib</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
<refname><function>DtMmdbOpenInfoLib</function></refname><refpurpose>opens an
infolib for service</refpurpose></refnamediv><refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;DtMmdb.h></funcsynopsisinfo>
<funcdef>int <function>DtMmdbOpenInfoLib</function></funcdef>
<paramdef>const char* <parameter>infolib_path</parameter></paramdef><paramdef>const char* <parameter>selected_base_name</parameter></paramdef><paramdef>DtMmdbBool <parameter>delayed_infolib_init</parameter></paramdef></funcsynopsis>
</refsynopsisdiv><refsect1>
<title>DESCRIPTION</title>
<para>The <function>DtMmdbOpenInfoLib</function> function opens an
infolib for user access and returns the descriptor for the
infolib. It makes the database engine ready to provide service
for an infolib. To obtain information about an infolib, use
the <function>DtMmdbInfoLibGetInfo</function> function.
</para>
</refsect1><refsect1>
<title>ARGUMENTS</title>
<variablelist>
<varlistentry><term><symbol role="Variable">infolib_path</symbol></term>
<listitem>
<para>Specifies the absolute path for the infolib.</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">selected_base_name</symbol></term>
<listitem>
<para>Specifies a single bookcase to be accessed in this session. A NULL
value indicates that all bookcases will be accessed.</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">delayed_infolib_init</symbol></term>
<listitem>
<para>Specifies whether the bookcase activation will be delayed until access
time. If you specify <systemitem class="Constant">DtMmdbTrue</systemitem>,
<function>DtMmdbOpenInfoLib</function> postpones the activation. This is
useful when you want faster Dtinfo Database Engine initialization.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1>
<title>RETURN VALUE</title>
<variablelist>
<varlistentry><term>-1</term>
<listitem>
<para>The initialization failed.</para>
</listitem>
</varlistentry>
<varlistentry><term>>=0</term>
<listitem>
<para>The initialization succeeded. The returned integer represents a valid
infolib descriptor.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1>
<title>EXAMPLE</title>
<para>The following shows how a <function>DtMmdbOpenInfoLib</function> call
might be coded.</para>
<informalexample>
<programlisting>DtMmdbOpenInfoLib(myInfoLibPath, "myBookCase", DtMmdbFalse);
</programlisting>
</informalexample>
</refsect1><refsect1>
<title>SEE ALSO</title>
<para>&cdeman.DtMmdbInfoLibGetInfo;, &cdeman.DtMmdbCloseInfoLib;</para>
</refsect1></refentry><?Pub Caret>
<?Pub *0000003874>