DC_PARSER_GET_FIELD(3)

💅 dc_parser_get_field(3) — like, the whole manual page, bestie

okay so real quick: this is from the Library Functions Manual (section 3, the function-calls one, iykyk), and it's the glow-up guide to dc_parser_get_field. it pulls one single field out of a dive you already parsed. that's the whole vibe. let's get into it ✨

---

🎀 NAME 🎀

dc_parser_get_field — extract a field from a parsed dive

📚 LIBRARY 📚

library “libdivecomputer”

🌸 SYNOPSIS 🌸

#include <libdivecomputer/parser.h>

dc_status_t
dc_parser_get_field(dc_parser_t *parser, dc_field_type_t type,
    unsigned int flags, void *value);

🦋 DESCRIPTION 🦋

so you've got a dive, right? and you've got a parser — one that you literally already set up with dc_parser_new(3) (we see you, preparer of parsers 👑). this function grabs a field out of it. 💖

here's the tea: the value field type is not one-size-fits-all — what you pass there depends entirely on the type you asked for. and the flags field? highkey ignored for every type except DC_FIELD_GASMIX and DC_FIELD_TANK. everyone else gets the silent treatment. 💀

the type can be any one of these bad boys:

• DC_FIELD_DIVETIME — how long the dive lasted, in seconds ⏱️. the value has to be an unsigned int.
• DC_FIELD_MAXDEPTH — deepest point, in metres 🌊. the value has to be a double.
• DC_FIELD_AVGDEPTH — average depth across all the samples, in metres. the value has to be a double.
• DC_FIELD_GASMIX_COUNT — how many different gas mixes got used on this dive 🫧. the value has to be a unsigned int.
• DC_FIELD_GASMIX — the mixture for one particular gas. the value has to be a dc_gasmix_t, which has double fields for oxygen, helium, and nitrogen. heads up: these are set to the unit fraction of gas, not a percentage 🙈. and the flags value is read as the gas mixture index — which has to be less than the value of DC_FIELD_GASMIX_COUNT. no skipping the line, bestie.
• DC_FIELD_SALINITY — the water salinity, as a dc_salinity_t field. that one's made of a type — either DC_WATER_FRESH or DC_WATER_SALT — plus the salinity density. 🧂
• DC_FIELD_ATMOSPHERIC — atmospheric pressure in bar. the value field has to be a double.
• DC_FIELD_TEMPERATURE_SURFACE — air temperature at the surface, in Celsius ☀️. the value field has to be a double.
• DC_FIELD_TEMPERATURE_MINIMUM — minimum water temperature surface, in Celsius 🥶. the value field has to be a double. (yes, the manual literally says “water temperature surface” — we don't make the rules, we just report them 💅)
• DC_FIELD_TEMPERATURE_MAXIMUM — maximum water temperature, in Celsius 🔥. the value field has to be a double.
• DC_FIELD_TANK_COUNT — the number of tanks, as an unsigned int.
• DC_FIELD_TANK — tank configuration, as a dc_tank_t. this structure is a whole little squad:
  • gasmix — retrievable with DC_FIELD_GASMIX
  • type — the tank volume units, one of DC_TANKVOLUME_NONE, DC_TANKVOLUME_IMPERIAL, or DC_TANKVOLUME_METRIC
  • volume — the tank volume in litres, or zero if the tank is DC_TANKVOLUME_NONE
  • workpressure — the work pressure in bar, or zero if DC_TANKVOLUME_NONE, and maybe zero if DC_TANKVOLUME_METRIC (life is unpredictable 😭)
  • beginpressure and endpressure — the pressures at start and finish, in bar

and the flags value here is the tank index. periodt.

• DC_FIELD_DIVEMODE — the mode of the dive, and there are five flavors:
  • DC_DIVEMODE_FREEDIVE — free-diving 🐬
  • DC_DIVEMODE_GAUGE — gauge mode, i.e. running as a plain record and not computing stuff like decompression events
  • DC_DIVEMODE_OC — standard open-circuit diving
  • DC_DIVEMODE_CCR — closed circuit “rebreather” diving
  • DC_DIVEMODE_SCR — semi closed circuit “rebreather” diving 🫧

ngl, when the manual says “DC_DIVEMODE_CCR and DC_DIVEMODE_SCR for respectively closed circuit and semi closed circuit” — that's your order, okay? CCR first, SCR second. don't mix 'em up. 🫶

---

⭐ RETURN VALUES ⭐

• DC_STATUS_SUCCESS — yay!! the field was retrieved 🎉
• DC_STATUS_UNSUPPORTED — the field just isn't supported by the device, no hard feelings 💔
• anything else — “other error messages on further failure” 😭 something else went wrong, go look at the error.

---

🔗 SEE ALSO 🔗

• dc_parser_new(3) — the origin story, start there bestie

---

👑 AUTHORS 👑

the library “libdivecomputer” library was written by Jef Driesen, jef@libdivecomputer.org. 🫶

the manpages were written by Kristaps Dzonsons, kristaps@bsd.lv.

---

and that's a wrap, babe 🎀 this page came to you from Debian, dated January 5, 2017, and the header on the tin says DC_PARSER_GET_FIELD(3). go forth and extract fields, icon 💅✨