DTMMDBSECTIONGETLOC(3)

πŸ“¦
version 2.5.3 Β· 2 versions
, in nixos 26.05

✨ NAME ✨

okay so bestie, this is DtMmdbSectionGetLoc from the library call manual β€” and it's literally the function that 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. Bestie, do not use the free function on the returned pointer. No table lookup is involved β€” it's giving direct, lowkey simple.

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. 😭

So like… if you need that string to survive past the next API call, copy it. Periodt.


πŸŽ€ 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. That's the whole vibe check πŸ‘‘


πŸ¦‹ 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 β€” yes bestie, that's literally what it says 🌸.


πŸ’– okay that's the whole page! source/version/date tea: the footer just repeats the DtMmdbSectionGetLoc(library call) tag, so there's no extra version or date info to spill β€” mwah πŸ’…πŸŽ€

πŸ“¦ where this page comes from