80 lines
3.3 KiB
Plaintext
80 lines
3.3 KiB
Plaintext
<!-- $XConsortium: MmdbBGTL.sgm /main/6 1996/09/08 20:05:16 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.DtMmdbBookGetTabList">]]><refmeta><refentrytitle>
|
|
DtMmdbBookGetTabList</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
|
<refname><function>DtMmdbBookGetTabList</function></refname><refpurpose>obtains
|
|
the list of tab sections in a book</refpurpose></refnamediv><refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
|
<funcdef>DtMmdbHandle** <function>DtMmdbBookGetTabList</function></funcdef>
|
|
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
|
<paramdef>unsigned int* <parameter>length</parameter></paramdef>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv><refsect1>
|
|
<title>DESCRIPTION</title>
|
|
<para>The <function>DtMmdbBookGetTabList</function> function
|
|
returns the list of tab sections for the specified book object. It returns
|
|
the list in a NULL-terminated array. Use the <function>DtMmdbFreeHandleList</function>
|
|
function to release the memory when the array is no longer needed. Table lookup is
|
|
involved when the identifier is specified by either the
|
|
<symbol role="Variable">primary_oid</symbol> or
|
|
<symbol role="Variable">sequence_num</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>, the
|
|
<symbol role="Variable">secondary_oid</symbol>, or the
|
|
<symbol role="Variable">sequence_num</symbol> field.
|
|
The <symbol role="Variable">primary_oid</symbol> represents the
|
|
DtInfo Database object identifier of the TOC section; the
|
|
<symbol role="Variable">secondary_oid</symbol> represents the
|
|
object identifier of the book itself; and the
|
|
<symbol role="Variable">sequence_num</symbol> represents
|
|
the sequence number of the book within the bookcase (0 based).
|
|
If more than one of these fields have a valid value, the
|
|
order of precedence is:
|
|
<symbol role="Variable">primary_oid</symbol>,
|
|
<symbol role="Variable">secondary_oid</symbol>, and, last,
|
|
<symbol role="Variable">sequence_num</symbol>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><symbol role="Variable">length</symbol></term>
|
|
<listitem>
|
|
<para>Specifies the variable to receive the length of the
|
|
returned list of sections, if the returned pointer to the list is not NULL.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1><refsect1>
|
|
<title>RETURN VALUE</title>
|
|
<para>If <function>DtMmdbBookGetTabList</function> completes
|
|
successfully, it returns a pointer to the list of sections
|
|
for the book. If it fails, it returns a NULL pointer.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>EXAMPLE</title>
|
|
<para>None.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>SEE ALSO</title>
|
|
<para>TO BE SUPPLIED.
|
|
</para>
|
|
<!--
|
|
&cdeman.DtMmdbBookGetTabList;,
|
|
&cdeman.DtMmdbBookGetTabList;
|
|
-->
|
|
</refsect1></refentry>
|
|
|