68 lines
2.7 KiB
Plaintext
68 lines
2.7 KiB
Plaintext
<!-- $XConsortium: MmdbTGCI.sgm /main/5 1996/09/08 20:09:25 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.DtMmdbTocGetChildIds">]]><refmeta><refentrytitle>
|
|
DtMmdbTocGetChildIds</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
|
<refname><function>DtMmdbTocGetChildIds</function></refname><refpurpose>obtains
|
|
a list of object identifiers for child sections</refpurpose></refnamediv><refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
|
<funcdef>DtMmdbHandle** <function>DtMmdbTocGetChildIds</function></funcdef>
|
|
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
|
<paramdef>unsigned int* <parameter>length</parameter></paramdef>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv><refsect1>
|
|
<title>DESCRIPTION</title>
|
|
<para>The <function>DtMmdbTocGetChildIds</function> function
|
|
returns an array of the object identifiers for the child sections
|
|
belonging to the specified section. Use
|
|
the <function>DtmmdbFreeHandleList</function> to release the array
|
|
when it is no longer needed.
|
|
</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>
|
|
<varlistentry><term><symbol role="Variable">length</symbol></term>
|
|
<listitem>
|
|
<para>Specifies the variable to receive the length of the
|
|
returned array (in bytes), if the returned pointer to the array
|
|
is not NULL. If it is set to zero, the section has no child section.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1><refsect1>
|
|
<title>RETURN VALUE</title>
|
|
<para>If <function>DtMmdbTocGetChildIds</function> completes
|
|
successfully, it returns a NULL-terminated object identifier array.
|
|
If it fails, it returns a NULL pointer.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>EXAMPLE</title>
|
|
<para>The following shows how a <function>DtMmdbTocGetChildIds</function> call
|
|
might be coded.</para>
|
|
<informalexample>
|
|
<programlisting>DtMmdbInfoRequest request; unsigned int length;
|
|
/* fill the request here */
|
|
handleList = DtMmdbTocGetChildIds(&request, &length);
|
|
</programlisting>
|
|
</informalexample>
|
|
</refsect1><refsect1>
|
|
<title>SEE ALSO</title>
|
|
<para>TO BE SUPPLIED
|
|
</para>
|
|
</refsect1></refentry>
|