DtMmdbSectionGetData(library call) DtMmdbSectionGetData(library call)
NAME [Toc] [Back]
DtMmdbSectionGetData - obtains the data for a section
SYNOPSIS [Toc] [Back]
#include <DtMmdb.h>
const char* DtMmdbSectionGetData(
DtMmdbInfoRequest* request,
unsigned int* length);
DESCRIPTION [Toc] [Back]
The DtMmdbSectionGetData function returns the data for the specified
section. Do not use the free function on the returned pointer. 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, DtMmdbSectionGetData ignores the locator_ptr value.
length Specifies the variable to receive the length of the returned
data, if the returned pointer to the data is not NULL.
RETURN VALUE [Toc] [Back]
If DtMmdbSectionGetData completes successfully, it returns a pointer
to a NULL-terminated data string. If it fails, it returns a NULL
pointer.
EXAMPLE [Toc] [Back]
The following shows how a DtMmdbSectionGetData call might be coded.
DtMmdbInfoRequest request;
/* fill the request */
DtMmdbSectionGetData(&request, 0);
SEE ALSO [Toc] [Back]
TO BE SUPPLIED
- 1 - Formatted: January 24, 2005 [ Back ] |