21742bd2ec
- Added missing man pages for the new functions. - Updated the main libdivecomputer man page to reflect the new flow. - Fixed minor typos in the dc_parser_get_field and dc_parser_samples_foreach functions.
73 lines
2.1 KiB
Groff
73 lines
2.1 KiB
Groff
.\"
|
|
.\" libdivecomputer
|
|
.\"
|
|
.\" Copyright (C) 2020 Vincent Hagen <vinnie@script4web.nl>
|
|
.\"
|
|
.\" 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 June 5, 2020
|
|
.Dt DC_DESCRIPTOR_GET_TRANSPORTS 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm dc_descriptor_get_transports
|
|
.Nd Gets the transports supported by the given descriptor.
|
|
.Sh LIBRARY
|
|
.Lb libdivecomputer
|
|
.Sh SYNOPSIS
|
|
.In libdivecomputer/descriptor.h
|
|
.Ft "unsigned int"
|
|
.Fo dc_descriptor_get_transports
|
|
.Fa "dc_descriptor_t *descriptor"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
Gets the transports supported by the given
|
|
.Fa descriptor .
|
|
The
|
|
.Fa descriptor
|
|
usually found by searching through
|
|
.Xr dc_descriptor_iterator 3 .
|
|
.Sh RETURN VALUES
|
|
Returns a union (bitwise OR) of the transports supported by the given
|
|
.Fa descriptor .
|
|
.Pp
|
|
The result is combination of
|
|
.Dv DC_TRANSPORT_USB ,
|
|
.Dv DC_TRANSPORT_USBHID ,
|
|
.Dv DC_TRANSPORT_BLE ,
|
|
.Dv DC_TRANSPORT_BLUETOOTH ,
|
|
.Dv DC_TRANSPORT_SERIAL ,
|
|
.Dv DC_TRANSPORT_IRDA
|
|
.Pp
|
|
To determine if a specific transport is supported use the following code
|
|
.Bd -literal -offset indent
|
|
unsigned int transports = dc_descriptor_get_transports(descriptor);
|
|
if(transports & DC_TRANSPORT_USBHID) {
|
|
// Device supports USB HID as transport
|
|
}
|
|
.Ed
|
|
.Sh SEE ALSO
|
|
.Xr dc_descriptor_iterator 3 .
|
|
.Sh AUTHORS
|
|
The
|
|
.Lb libdivecomputer
|
|
library was written by
|
|
.An Jef Driesen ,
|
|
.Mt jef@libdivecomputer.org .
|
|
.br
|
|
This manpage is written by
|
|
.An Vincent Hagen ,
|
|
.Mt vinnie@script4web.nl .
|