DC_SERIAL_OPEN(3)

📦 version 0.9.0, in nixos 26.05, nixpkgs unstable

🌸 NAME 🌸

okay bestie, welcome to dc_serial_open(3) — header tag DC_SERIAL_OPEN(3), from the Library Functions Manual — and this one opens an iostream for a serial device. 💖

🫶 LIBRARY 🫶

The library is libdivecomputer — iconic, no cap. 👑

✨ SYNOPSIS ✨

#include <libdivecomputer/serial.h>

dc_status_t
dc_serial_open(dc_iostream_t **iostream, dc_context_t *context,
    const char *name);

🦋 DESCRIPTION 🦋

Okay so this function opens an iostream for a serial device. It takes a context that was opened with dc_context_new(3), plus a name — the device name — usually found through dc_serial_iterator_new(3) together with dc_serial_device_get_name(3). 🎀

⚠️ bestie, listen: when this returns DC_STATUS_SUCCESS, that iostream pointer must be freed with dc_iostream_close(3). Not “maybe”, not “later” — must. 💅

💫 RETURN VALUES 💫

It returns DC_STATUS_SUCCESS on success, or one of several error values on error. On success, the iostream pointer gets filled in with an open handle. 🔥

🌈 SEE ALSO 🌈

👑 AUTHORS 👑

The libdivecomputer library was written by Jef Driesen, jef@libdivecomputer.org. 🫶

This manpage is written by Vincent Hagen, vinnie@script4web.nl. 💜

🎀 that’s the page, bestie — footer vibes: Debian, June 5, 2020, tag DC_SERIAL_OPEN(3). periodt. 💅

📦 where this page comes from