DTSEARCHGETKEYTYPES(3)

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

✨ NAME ✨

okay so bestie, this is the DtSearchGetKeytypes page from the library call manual β€” and it's literally the function that gives you access to the Keytypes array for a DtSearch database. iconic behavior, no cap πŸ’…

🌸 SYNOPSIS 🌸

copy these lines exactly, iykyk:

#include &<Dt/Search.h>
int DtSearchGetKeytypes(
char *dbname,
int *ktcount,
DtSrKeytype **keytypes);

πŸ¦‹ DESCRIPTION πŸ¦‹

DtSearchGetKeytypes returns a pointer to the keytypes array of the specified database. that's the main character move ✨

you're allowed to modify the is_selected member of any DtSrKeytype β€” go off, customize that one β€” but do not alter any other member values. like, hands off the rest, fr fr πŸ™ˆ

this function may be called anytime after DtSearchInit. anytime, bestie. after init, you're cleared for takeoff 🫢

πŸŽ€ ARGUMENTS πŸŽ€

  • dbname β€” tells the function which database you want the keytypes for. it's any one of the database name strings from the array returned from DtSearchInit or DtSearchReinit. if dbname is NULL, the first database name string in the array is used β€” default queen behavior πŸ‘‘
  • ktcount β€” this is the address of the integer where the keytypes array size will be stored. so yes, it's giving β€œhere's where you put the count” πŸ“₯
  • keytypes β€” this is the address where the pointer to the keytypes array will be stored. it's the spot for the pointer, periodt 🎯

πŸ’– RETURN VALUE πŸ’–

Returns DtSrOK and keytypes pointer and size. slay βœ…

Any API function can also return DtSrREINIT or the return codes for fatal engine errors, as well as messages on the MessageList, at any time. so yeah, keep an eye out β€” API functions can surprise you like that 😭

🌈 SEE ALSO 🌈


final footer vibe: DtSearchGetKeytypes(library call) β€” that's the library call manual page, bestie. no date was included in the footer, so we're not inventing one, periodt πŸŽ€πŸ’œ

πŸ“¦ where this page comes from