58 lines
2.4 KiB
Plaintext
58 lines
2.4 KiB
Plaintext
<!-- $XConsortium: MmdbBGSN.sgm /main/4 1996/08/25 20:55:37 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.DtMmdbBookGetSeqNum">]]><refmeta><refentrytitle>
|
|
DtMmdbBookGetSeqNum</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
|
<refname><function>DtMmdbBookGetSeqNum</function></refname><refpurpose>obtains
|
|
the sequence number of a book</refpurpose></refnamediv><refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
|
<funcdef>int <function>DtMmdbBookGetSeqNum</function></funcdef>
|
|
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv><refsect1>
|
|
<title>DESCRIPTION</title>
|
|
<para>The <function>DtMmdbBookGetSeqNum</function> function returns
|
|
the sequence number of the specified book object. Table lookup is involved
|
|
when the identifier is specified by the
|
|
<symbol role="Variable">primary_oid</symbol> field.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>ARGUMENTS</title>
|
|
<variablelist>
|
|
<varlistentry><term><symbol role="Variable">request</symbol></term>
|
|
<listitem>
|
|
<para>Specifies the bookcase in the bookcase descriptor field, as well
|
|
as a valid value in the <symbol role="Variable">primary_oid</symbol> or
|
|
the <symbol role="Variable">secondary_oid</symbol> field.
|
|
The <symbol role="Variable">primary_oid</symbol> represents the
|
|
DtInfo Database object identifier of the TOC section; and the
|
|
<symbol role="Variable">secondary_oid</symbol> represents the
|
|
object identifier of the book itself. If both of these fields have
|
|
a valid value, the order of precedence is:
|
|
<symbol role="Variable">primary_oid</symbol>
|
|
and then <symbol role="Variable">secondary_oid</symbol>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1><refsect1>
|
|
<title>RETURN VALUE</title>
|
|
<para>If <function>DtMmdbBookGetSeqNum</function> completes
|
|
successfully, it returns the sequence number of the book.
|
|
If it fails, it returns -1.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>EXAMPLE</title>
|
|
<para>None.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>SEE ALSO</title>
|
|
<para>TO BE SUPPLIED.</para>
|
|
</refsect1></refentry>
|