DC_SERIAL_ITERATOR_NEW(3) | Library Functions Manual | DC_SERIAL_ITERATOR_NEW(3) |
dc_serial_iterator_new
—
#include
<libdivecomputer/serial.h>
dc_status_t
dc_serial_iterator_new
(dc_iterator_t
**iterator, dc_context_t *context,
dc_descriptor_t *descriptor);
On returning DC_STATUS_SUCCESS
the
iterator will be set to an
dc_iterator_t which can be used to iterate the
available serial devices using
dc_iterator_next(3).
The value type of the iterator is of type dc_serial_device_t. This value can be used in functions to extract information about this specific serial device, namely dc_serial_device_get_name(3) When done the serial device needs to be freed with dc_serial_device_free(3).
After iterating the iterator needs to be freed using dc_iterator_free(3).
DC_STATUS_SUCCESS
on success, or another
dc_status_t code on failure.
On DC_STATUS_SUCCESS
the returned
iterator needs to be freed when done using
dc_iterator_free(3).
June 5, 2020 | NetBSD 10.0 |