57 lines
1.5 KiB
Groff
57 lines
1.5 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_ITERATOR_FREE 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm dc_iterator_free
|
|
.Nd frees an iterator
|
|
.Sh LIBRARY
|
|
.Lb libdivecomputer
|
|
.Sh SYNOPSIS
|
|
.In libdivecomputer/iterator.h
|
|
.Ft dc_status_t
|
|
.Fo dc_iterator_free
|
|
.Fa "dc_iterator_t *iterator"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
Frees the iterator
|
|
.Fa iterator .
|
|
It may be invoked on any iterator type, e.g., one created with
|
|
.Xr dc_descriptor_iterator 3 .
|
|
.Sh RETURN VALUES
|
|
This returns
|
|
.Dv DC_STATUS_SUCCESS
|
|
on success (or if
|
|
.Fa iterator
|
|
is
|
|
.Dv NULL )
|
|
or other values on failure.
|
|
.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 .
|