DC_SERIAL_OPEN(3)

DC_SERIAL_OPEN(3) | Library Functions Manual | DC_SERIAL_OPEN(3)

# NAME

`dc_serial_open` — Opens an iostream for a serial device

# LIBRARY

library “libdivecomputer”

# SYNOPSIS

`#include <libdivecomputer/serial.h>`

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

# DESCRIPTION

Opens an iostream for a serial device. Accepts a context opened with dc_context_new(3) and a name device name, usually found through dc_serial_iterator_new(3) with dc_serial_device_get_name(3).

Upon returning `DC_STATUS_SUCCESS`, the iostream pointer must be freed with dc_iostream_close(3).

# RETURN VALUES

Returns `DC_STATUS_SUCCESS` on success or one of several error values on error. On success, the iostream pointer is filled in with an open handle.

# SEE ALSO

dc_context_new(3), dc_iostream_close(3), dc_usbhid_open(3), dc_irda_open(3), dc_bluetooth_open(3), dc_serial_iterator_new(3), dc_serial_device_get_name(3).

# AUTHORS

The library “libdivecomputer” library was written by Jef Driesen, jef@libdivecomputer.org.
This manpage is written by
Vincent Hagen, vinnie@script4web.nl.

June 5, 2020 | NetBSD 11.0