DtMmdbSectionGetLoc(library call) DtMmdbSectionGetLoc(library call)
NAME
DtMmdbSectionGetLoc -- obtains a section's locator
SYNOPSIS
#include <DtMmdb.h>
const char* DtMmdbSectionGetLoc(
DtMmdbInfoRequest* request);
DESCRIPTION
The DtMmdbSectionGetLoc function returns the logical identifier for the specified section. Do not use the free function on the returned
pointer. No table lookup is involved.
The space used by the returned locator pointer is likely to be reused by the database engine when any of the API functions are invoked
again. You must make a copy of the content if you want to retain it across multiple API calls. This behavior holds true for all functions
that return a const char* pointer.
ARGUMENTS
request Specifies the bookcase in the bookcase descriptor field and the section's Database Engine (object) identifier in the primary_oid
field. The DtInfo Database Engine identifier is assigned to the section when it is stored.
RETURN VALUE
If DtMmdbSectionGetLoc completes successfully, it returns a pointer to a NULL-terminated locator string. If it fails, it returns a NULL
pointer.
EXAMPLE
The following shows how a DtMmdbSectionGetLoc call might be coded.
const char* locator = 0;
DtMmdbInfoRequest request;
int bd = DtMmdbGetBookCase(myInfoLibPtr, "myBase");
if ( bd >= 0) {
request.bookcase_descriptor = bd;
request.sequence_num = 1;
request.primary_oid = DtMmdbBookGetTocObjectId(&request);
locator = DtMmdbSectionGetLoc(&request);
}
SEE ALSO
TO BE SUPPLIED
DtMmdbSectionGetLoc(library call)
Check Out this Related Man Page
DtMmdbBookGetTocObjectId(library call) DtMmdbBookGetTocObjectId(library call)
NAME
DtMmdbBookGetTocObjectId -- obtains the locator of a book's TOC section
SYNOPSIS
#include <DtMmdb.h>
DtMmdbHandle* DtMmdbBookGetTocObjectId(
DtMmdbInfoRequest* request);
DESCRIPTION
The DtMmdbBookGetTocObjectId function returns the object identifier of the specified book's TOC section. Use the DtMmdbFreeHandleList
function to release the memory when the object identifier is no longer needed. Table lookup is involved when the identifier is specified by
either the primary_oid or sequence_num field.
ARGUMENTS
request Specifies the bookcase in the bookcase descriptor field, as well as a valid value in the primary_oid, the secondary_oid, or the
sequence_num field. The primary_oid represents the DtInfo Database object identifier of the TOC section; the secondary_oid rep-
resents the object identifier of the book itself; and the sequence_num represents the sequence number of the book within the
bookcase (0 based). If more than one of these fields have a valid value, the order of precedence is: primary_oid, secondary_oid,
and, last, sequence_num.
RETURN VALUE
If DtMmdbBookGetTocObjectId completes successfully, it returns a pointer to the object identifier for the book's TOC section. If it fails,
it returns a NULL pointer.
EXAMPLE
The following shows how a DtMmdbBookGetTocObjectId call might be coded.
DtMmdbInfoRequest request;
request.bookcase_descriptor = DtMmdbGetBookCase(myInfoLibPtr, "myBase");
request.sequence_num = 1;
DtMmdbBookGetTocObjectId(&request);
SEE ALSO
TO BE SUPPLIED.
DtMmdbBookGetTocObjectId(library call)