gd_protection(3)

✨ gd_protection — bestie edition ✨

okay so this is gd_protection(3), part of the GETDATA manual, and it's genuinely so useful. sit down, hydrate, let's go 💖

🌸 NAME 🌸

gd_protection — the function that reports the protection level of a Dirfile fragment. yes. that's the whole job. and it does it flawlessly. periodt. 💅

🦋 SYNOPSIS 🦋

#include <getdata.h>

int gd_protection(DIRFILE *dirfile, int fragment_index);

that's it. two arguments. one int back. iconic behavior honestly.

🎀 DESCRIPTION 🎀

so gd_protection() queries a dirfile(5) database — the one you hand it as dirfile — and figures out the advisory protection level for the fragment indexed by fragment_index.

like, it's not a bodyguard. it's the advisor. it tells you what the vibe check says about that fragment's protection. no cap. 🫶

💜 RETURN VALUE 💜

when it slays (i.e. succeeds), gd_protection() returns a non-negative integer — the advisory protection level of the fragment you asked about. and that integer is gonna be one of these symbols, fr fr:

GD_PROTECT_NONE, GD_PROTECT_FORMAT, GD_PROTECT_DATA,
GD_PROTECT_ALL.

what do they mean though? bestie, the meanings are explained over in the gd_alter_protection(3) man page. go look, i'll wait. 👑

but on error? 😭 it returns a negative-valued error code. the possible error codes are:

• GD_E_BAD_DIRFILE — the dirfile you supplied was invalid. not it. 🙈
• GD_E_BAD_INDEX — the index you supplied was out of range. literally out of bounds, bestie. 💀

and listen — that error code also gets stored in the DIRFILE object, so you can go grab it after the function returns by calling gd_error(3). want a whole descriptive error string instead of a number? that's gd_error_string(3). two icons, both serving. ✨

🌈 HISTORY 🌈

• get_protection() first appeared in GetData-0.5.0. baby's first era. 🍼
• in GetData-0.7.0 it got renamed to gd_protection(). glow-up. 💅
• in GetData-0.10.0, the error return changed from -1 to a negative-valued error code. character development. 🔥

⭐ SEE ALSO ⭐

• gd_open(3)
• gd_alter_protection(3)
• gd_error(3)
• gd_error_string(3)
• dirfile(5)
• dirfile-format(5)

go read them. all of them. for me. 🥺

Version 0.10.0 · 25 December 2016 — and that's the whole page bestie, mwah, go forth and check your protection levels responsibly 💖🦋✨