hdf_obj_top(3)

💖 hdf_obj_top — bestie, lemme introduce u to util/neo_hdf.h ✨

okay so this is hdf_obj_top(3), and no cap it's one of the shortest lil functions in the whole hdf fam, but it's lowkey iconic. sit down, grab a strawberry 🍓, let's go.

🌸 NAME 🌸

hdf_obj_top — Return the pointer to the top dataset node

like literally that's it, that's the whole job. she points at the top. main character energy, minimal effort 💅

✨ SYNOPSIS ✨

#include <util/neo_hdf.h>

HDF* hdf_obj_top (HDF *hdf);

🎀 ARGUMENTS 🎀

• hdf — the hdf dataset node. yes bestie, any node. it doesn't have to be the top one already, she'll find her way home 🏠

🦋 DESCRIPTION 🦋

okay so hdf_obj_top is an accessor function — meaning she's not out here changing anything, she's just handing u a pointer, okurrr — and what she returns is a pointer to the top of the dataset. that's the node which was returned by hdf_init. the origin. the mothership. the one that started it all 👑

and why would u even want that?? the way that this is most useful for implementations of language wrappers where individual nodes are tied garbage collection wise to the top node of the data set. so like, when ur wrapping this in some other language and the lil baby nodes need to keep the big top node alive so nobody gets freed too early — that's the vibe. it's giving "keep the parent on the line so the kids don't get collected" 😭🫶

ngl if u don't know what garbage collection is, the short version: stuff gets deleted when nobody's holding onto it anymore. this function is how u hold onto the top. iykyk.

🌈 RETURN VALUE 🌈

None

(fr fr. the original says none. yes that's a lil weird for a function whose whole thing is returning a pointer, but that's what the page says and we do NOT editorialize on the classics 🙈)

💜 SEE ALSO 💜

the whole squad, in the exact order they showed up:

• hdf_set_symlink(3)
• hdf_get_valuef(3)
• compareFunc)(3)
• hdf_dump_str(3)
• hdf_get_int_value(3)
• hdf_read_string_ignore(3)
• hdf_copy(3)
• hdf_get_node(3)
• hdf_set_value(3)
• hdf_obj_child(3)
• hdf_read_string(3)
• hdf_set_buf(3)
• hdf_register_fileload(3)
• hdf_get_obj(3)
• hdf_get_attr(3)
• hdf_obj_top(3)
• hdf_dump_format(3)
• hdf_destroy(3)
• hdf_init(3)
• hdf_obj_value(3)
• hdf_write_string(3)
• hdf_set_valuevf(3)
• hdf_sort_obj(3)
• hdf_write_file_atomic(3)
• hdf_obj_attr(3)
• hdf_set_valuef(3)
• hdf_get_copy(3)
• hdf_write_file(3)
• hdf_get_valuevf(3)
• hdf_set_int_value(3)
• hdf_dump(3)
• hdf_get_value(3)
• hdf_set_copy(3)
• hdf_obj_next(3)
• hdf_search_path(3)
• hdf_obj_name(3)
• hdf_set_attr(3)
• hdf_get_child(3)
• hdf_remove_tree

(not me noticing compareFunc)(3) and bare hdf_remove_tree at the end — we're keeping them EXACTLY as written, no fixing, no cap, that's the lore ✨)

and that's the whole page bestie!! go forth and point at the top of ur dataset 🫶

mwah 💋 — this lil page is brought to u by ClearSilver, dated 12 July 2007. yeah she's vintage. she's a classic. she still ate. 💅✨