Merge remote-tracking branch 'keys/keys-next'
[deliverable/linux.git] / Documentation / media / uapi / 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
15e7d615 9Name
586027ce 10====
5377d91f 11
586027ce 12FE_READ_SIGNAL_STRENGTH
5377d91f 13
cf8076c3 14.. attention:: This ioctl is deprecated.
15e7d615
MCC
15
16Synopsis
586027ce 17========
5377d91f 18
cf8076c3
MCC
19.. c:function:: int ioctl( int fd, FE_READ_SIGNAL_STRENGTH, uint16_t *strength)
20 :name: FE_READ_SIGNAL_STRENGTH
5377d91f 21
5377d91f 22
15e7d615 23Arguments
586027ce 24=========
5377d91f 25
cf8076c3
MCC
26``fd``
27 File descriptor returned by :c:func:`open() <dvb-fe-open>`.
5377d91f 28
cf8076c3
MCC
29``strength``
30 The signal strength value is stored into \*strength.
5377d91f
MH
31
32
15e7d615 33Description
586027ce
MCC
34===========
35
36This ioctl call returns the signal strength value for the signal
37currently received by the front-end. For this command, read-only access
38to the device is sufficient.
39
40
15e7d615 41Return Value
586027ce 42============
5377d91f
MH
43
44On success 0 is returned, on error -1 and the ``errno`` variable is set
45appropriately. The generic error codes are described at the
46:ref:`Generic Error Codes <gen-errors>` chapter.
This page took 0.051912 seconds and 5 git commands to generate.