home | help
DC_DEVICE_FOREACH(3)	     Library Functions Manual	    DC_DEVICE_FOREACH(3)

NAME
     dc_device_foreach -- iterate over dives in a dive computer

LIBRARY
     libdivecomputer

SYNOPSIS
     #include <libdivecomputer/device.h>

     typedef int
     (*dc_dive_callback_t)(const unsigned char *data, unsigned int size,
	 const unsigned char *fingerprint, unsigned int fsize, void *userdata);

     dc_status_t
     dc_device_foreach(dc_device_t *device, dc_dive_callback_t callback,
	 void *userdata);

DESCRIPTION
     Iterate over all dives on device by calling callback with userdata.

     Each  dive invokes callback with the dive data, which should be parsed with
     dc_parser_set_data(3), and the binary fingerprint of the dive.  The finger-
     print can be used to record the newest dive and stop processing (on  subse-
     quent invocations) when the same dive fingerprint is encountered.

     The  callback  function must return non-zero to continue downloading dives,
     or zero to stop.

RETURN VALUES
     This returns DC_STATUS_SUCCESS on success or one of several error values on
     error.  If callback returns zero, this will not be reflected in the  return
     value (usually DC_STATUS_SUCCESS).

SEE ALSO
     dc_parser_set_data(3)

AUTHORS
     The  libdivecomputer  library  was  written by Jef Driesen, jef@libdivecom-
     puter.org.  The manpages were written by
     Kristaps Dzonsons, kristaps@bsd.lv.

FreeBSD ports 15.quarterly	 January 5, 2017	    DC_DEVICE_FOREACH(3)

home | help