Peter Howkins
66 lines
2.5 KiB
Plaintext
66 lines
2.5 KiB
Plaintext
<!-- $XConsortium: MmdbTGPI.sgm /main/5 1996/09/08 20:09:43 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.DtMmdbTocGetParentId">]]><refmeta><refentrytitle>
|
|
DtMmdbTocGetParentId</refentrytitle><manvolnum>library call</manvolnum></refmeta><refnamediv>
|
|
<refname><function>DtMmdbTocGetParentId</function></refname><refpurpose>obtains
|
|
the object identifier of the parent section</refpurpose></refnamediv><refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>#include <DtMmdb.h></funcsynopsisinfo>
|
|
<funcdef>DtMmdbHandle* <function>DtMmdbTocGetParentId</function></funcdef>
|
|
<paramdef>DtMmdbInfoRequest* <parameter>request</parameter></paramdef>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv><refsect1>
|
|
<title>DESCRIPTION</title>
|
|
<para>The <function>DtMmdbTocGetParentId</function> function
|
|
returns the object identifier of the section that is parent to the
|
|
specified section. Use the <function>DtMmdbFreeHandle</function>
|
|
to release the identifier 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>
|
|
</variablelist>
|
|
</refsect1><refsect1>
|
|
<title>RETURN VALUE</title>
|
|
<para>If <function>DtMmdbTocGetParentId</function> completes
|
|
successfully, it returns the object identifier of the parent section.
|
|
If it fails, it returns a NULL pointer.
|
|
</para>
|
|
</refsect1><refsect1>
|
|
<title>EXAMPLE</title>
|
|
<para>The following shows how a <function>DtMmdbTocGetParentId</function> call
|
|
might be coded.</para>
|
|
<informalexample>
|
|
<programlisting>DtMmdbInfoRequest request;
|
|
/* fill the request here */
|
|
DtMmdbHandle* parent = DtMmdbTocGetParentId(&request);
|
|
if (parent != DtMmdbGroundId) {
|
|
if (parent == 0) {
|
|
/* invalid request */
|
|
} else {
|
|
/* parent points at the parent section */
|
|
}
|
|
} else { /* this section is the root section */
|
|
}
|
|
</programlisting>
|
|
</informalexample>
|
|
</refsect1><refsect1>
|
|
<title>SEE ALSO</title>
|
|
<para>TO BE SUPPLIED
|
|
</para>
|
|
</refsect1></refentry>
|