blob: 75eab893c184960834610700bd96c5db39f29b51 [file] [log] [blame]
.. -*- coding: utf-8; mode: rst -*-
.. _FE_GET_EVENT:
************
FE_GET_EVENT
************
DESCRIPTION
This ioctl call returns a frontend event if available. If an event is
not available, the behavior depends on whether the device is in blocking
or non-blocking mode. In the latter case, the call fails immediately
with errno set to EWOULDBLOCK. In the former case, the call blocks until
an event becomes available.
SYNOPSIS
int ioctl(int fd, int request = QPSK_GET_EVENT, struct
dvb_frontend_event *ev);
PARAMETERS
.. flat-table::
:header-rows: 0
:stub-columns: 0
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals :ref:`FE_GET_EVENT <FE_GET_EVENT>` for this command.
- .. row 3
- struct dvb_frontend_event *ev
- Points to the location where the event,
- .. row 4
-
- if any, is to be stored.
RETURN VALUE
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
.. flat-table::
:header-rows: 0
:stub-columns: 0
- .. row 1
- EWOULDBLOCK
- There is no event pending, and the device is in non-blocking mode.
- .. row 2
- EOVERFLOW
- Overflow in event queue - one or more events were lost.
.. ------------------------------------------------------------------------------
.. This file was automatically converted from DocBook-XML with the dbxml
.. library (https://github.com/return42/sphkerneldoc). The origin XML comes
.. from the linux kernel, refer to:
..
.. * https://github.com/torvalds/linux/tree/master/Documentation/DocBook
.. ------------------------------------------------------------------------------