63f5a4d652
The dc_parser_set_data() function allows to re-use a parser object for multiple dives. The advantages of this feature are actually very limited in practice. The reduction in memory consumption is almost negligible, because the amount of internal state in the parser is typically very small. But the implementation requires some additional complexity because each backend needs code to reset its internal state. Therefore, the function is removed and the data and size needs to be passed directly to the dc_parser_new() and dc_parser_new2() functions instead. Because keeping a reference to the data has also caused issues in the past, especially for applications implemented in a garbage collected language, the data will now also get copied internally.
70 lines
1.9 KiB
Groff
70 lines
1.9 KiB
Groff
.\"
|
|
.\" libdivecomputer
|
|
.\"
|
|
.\" Copyright (C) 2017 Kristaps Dzonsons <kristaps@bsd.lv>
|
|
.\"
|
|
.\" This library is free software; you can redistribute it and/or
|
|
.\" modify it under the terms of the GNU Lesser General Public
|
|
.\" License as published by the Free Software Foundation; either
|
|
.\" version 2.1 of the License, or (at your option) any later version.
|
|
.\"
|
|
.\" This library is distributed in the hope that it will be useful,
|
|
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
.\" Lesser General Public License for more details.
|
|
.\"
|
|
.\" You should have received a copy of the GNU Lesser General Public
|
|
.\" License along with this library; if not, write to the Free Software
|
|
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
|
.\" MA 02110-1301 USA
|
|
.\"
|
|
.Dd January 5, 2017
|
|
.Dt DC_PARSER_GET_DATETIME 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm dc_parser_get_datetime
|
|
.Nd extract the date and time from a parsed dive
|
|
.Sh LIBRARY
|
|
.Lb libdivecomputer
|
|
.Sh SYNOPSIS
|
|
.In libdivecomputer/parser.h
|
|
.Ft dc_status_t
|
|
.Fo dc_parser_get_datetime
|
|
.Fa "dc_parser_t *parser"
|
|
.Fa "dc_datetime_t *datetime"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
Extract the date and time of a dive,
|
|
.Fa parser ,
|
|
previously initialised with
|
|
.Xr dc_parser_new 3 .
|
|
This returns the broken-down time-stamp of the dive in the local time of
|
|
the dive.
|
|
.Pp
|
|
The
|
|
.Nm
|
|
function may internally invoke
|
|
.Xr dc_datetime_gmtime 3
|
|
or
|
|
.Xr dc_datetime_localtime 3 .
|
|
.Sh RETURN VALUES
|
|
Returns
|
|
.Dv DC_STATUS_SUCCESS
|
|
if the date and time were retrieved,
|
|
.Dv DC_STATUS_UNSUPPORTED
|
|
if the date and time are not supported by the device, or other error
|
|
messages on further failure.
|
|
.Sh SEE ALSO
|
|
.Xr dc_datetime_gmtime 3 ,
|
|
.Xr dc_datetime_localtime 3 ,
|
|
.Xr dc_parser_new 3
|
|
.Sh AUTHORS
|
|
The
|
|
.Lb libdivecomputer
|
|
library was written by
|
|
.An Jef Driesen ,
|
|
.Mt jef@libdivecomputer.org .
|
|
The manpages were written by
|
|
.An Kristaps Dzonsons ,
|
|
.Mt kristaps@bsd.lv .
|