home | help
DC_BLUETOOTH_ITERATOR_NEW(3) Library Functions ManuaDC_BLUETOOTH_ITERATOR_NEW(3)

NAME
     dc_bluetooth_iterator_new	-- Create an iterator to enumerate the bluetooth
     devices.

LIBRARY
     libdivecomputer

SYNOPSIS
     #include <libdivecomputer/bluetooth.h>

     dc_status_t
     dc_bluetooth_iterator_new(dc_iterator_t **iterator, dc_context_t *context,
	 dc_descriptor_t *descriptor);

DESCRIPTION
     Iterates through the available bluetooth devices which  matches  the  given
     descriptor.    Accepts  a	context  opened  with  dc_context_new(3)  and  a
     descriptor usually found by searching through dc_descriptor_iterator(3).

     On returning DC_STATUS_SUCCESS the iterator will be set to an dc_iterator_t
     which can be used to iterate the available bluetooth devices using dc_iter-
     ator_next(3).

     The value type of the iterator  is  of  type  dc_bluetooth_device_t.   This
     value  can  be used in functions to extract information about this specific
     bluetooth	device,  namely  dc_bluetooth_device_get_name(3)  and	dc_blue-
     tooth_device_get_address(3).   When  done	the bluetooth device needs to be
     freed with dc_bluetooth_device_free(3).

     After iterating the iterator needs to be freed using dc_iterator_free(3).

RETURN VALUES
     Returns DC_STATUS_SUCCESS on success, or another dc_status_t code on  fail-
     ure.

     On  DC_STATUS_SUCCESS the returned iterator needs to be freed when done us-
     ing dc_iterator_free(3).

SEE ALSO
     dc_context_new(3),  dc_usbhid_iterator_new(3),   dc_serial_iterator_new(3),
     dc_irda_iterator_new(3),  dc_bluetooth_device_get_name(3), dc_bluetooth_de-
     vice_get_address(3), dc_bluetooth_device_free(3).

AUTHORS
     The libdivecomputer library was written  by  Jef  Driesen,  jef@libdivecom-
     puter.org.
     This manpage is written by
     Vincent Hagen, vinnie@script4web.nl.

FreeBSD ports 15.quarterly	  June 5, 2020	    DC_BLUETOOTH_ITERATOR_NEW(3)

home | help