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

<!-- $XConsortium: MmdbTGNC.sgm /main/5 1996/09/08 20:09:34 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.DtMmdbTocGetNumOfChild">]]>
<refmeta><refentrytitle>
DtMmdbTocGetNumOfChildren</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
<refname><function>DtMmdbTocGetNumOfChildren</function></refname><refpurpose>obtains
the number of child sections</refpurpose></refnamediv><refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;DtMmdb.h></funcsynopsisinfo>
<funcdef>int <function>DtMmdbTocGetNumOfChildren</function></funcdef>
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
</funcsynopsis>
</refsynopsisdiv><refsect1>
<title>DESCRIPTION</title>
<para>The <function>DtMmdbTocGetNumOfChildren</function> function
returns the number of child sections for the specified section.
</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 and
the section's Database Engine identifier, in the
<symbol role="Variable">primary_oid</symbol> field.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1>
<title>RETURN VALUE</title>
<para>If <function>DtMmdbTocGetNumOfChildren</function> completes
successfully, it returns the number of child sections.
If it fails, it returns -1.
</para>
</refsect1><refsect1>
<title>EXAMPLE</title>
<para>The following shows how a <function>DtMmdbTocGetNumOfChildren</function> call
might be coded.</para>
<informalexample>
<programlisting>DtMmdbInfoRequest request;
/* fill the request here */
n = DtMmdbTocGetNumOfChildren(&amp;request);
</programlisting>
</informalexample>
</refsect1><refsect1>
<title>SEE ALSO</title>
<para>TO BE SUPPLIED
</para>
</refsect1></refentry>