DtMmdbSectionGetTocLoc(library call) DtMmdbSectionGetTocLoc(library call)
NAME [Toc] [Back]
DtMmdbSectionGetTocLoc - obtains the locator for a book's TOC section
SYNOPSIS [Toc] [Back]
#include <DtMmdb.h>
const char* DtMmdbSectionGetTocLoc(
DtMmdbInfoRequest* request);
DESCRIPTION [Toc] [Back]
The DtMmdbSectionGetTocLoc function returns the locator of the TOC
section of the book that contains the specified section. Table lookup
is involved if the section identifier is specified by the locator_ptr
field.
ARGUMENTS [Toc] [Back]
request Specifies the bookcase in the bookcase descriptor field and
either the section's Database Engine identifier (in the
primary_oid field) or the section's logical identifier (in
the locator_ptr field). If both of these fields have a
value, DtMmdbSectionGetTocLoc uses the locator_ptr value.
RETURN VALUE [Toc] [Back]
If DtMmdbSectionGetTocLoc completes successfully, it returns a pointer
to the book's TOC section. If it fails, it returns a NULL pointer.
EXAMPLE [Toc] [Back]
The following shows how a DtMmdbSectionGetTocLoc call might be coded.
DtMmdbInfoRequest request;
/* fill the request here */
locator = DtMmdbSectionGetTocLoc(&request);
SEE ALSO [Toc] [Back]
TO BE SUPPLIED
- 1 - Formatted: January 24, 2005 [ Back ] |
