doc-rst: customize RTD theme, captions & inline literal
[deliverable/linux.git] / Documentation / linux_tv / media / dvb / fe-read-signal-strength.rst
CommitLineData
5377d91f
MH
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _FE_READ_SIGNAL_STRENGTH:
4
5***********************
6FE_READ_SIGNAL_STRENGTH
7***********************
8
586027ce
MCC
9NAME
10====
5377d91f 11
586027ce 12FE_READ_SIGNAL_STRENGTH
5377d91f 13
586027ce
MCC
14SYNOPSIS
15========
5377d91f 16
5d468e2b 17.. c:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength)
5377d91f 18
5377d91f 19
586027ce
MCC
20ARGUMENTS
21=========
5377d91f
MH
22
23.. flat-table::
24 :header-rows: 0
25 :stub-columns: 0
26
27
28 - .. row 1
29
30 - int fd
31
32 - File descriptor returned by a previous call to open().
33
34 - .. row 2
35
36 - int request
37
38 - Equals
0579e6e3
MCC
39 :ref:`FE_READ_SIGNAL_STRENGTH`
40 for this command.
5377d91f
MH
41
42 - .. row 3
43
5d468e2b 44 - uint16_t \*strength
5377d91f 45
5d468e2b 46 - The signal strength value is stored into \*strength.
5377d91f
MH
47
48
586027ce
MCC
49DESCRIPTION
50===========
51
52This ioctl call returns the signal strength value for the signal
53currently received by the front-end. For this command, read-only access
54to the device is sufficient.
55
56
57RETURN VALUE
58============
5377d91f
MH
59
60On success 0 is returned, on error -1 and the ``errno`` variable is set
61appropriately. The generic error codes are described at the
62:ref:`Generic Error Codes <gen-errors>` chapter.
This page took 0.030936 seconds and 5 git commands to generate.