forked from Minki/linux
cf8076c314
Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. While here, improve the documentation, marking the deprecated ioctls, and making the non-deprecated ones more like the rest of the media book. Also, add a notice for ioctls that still require documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
61 lines
1.1 KiB
ReStructuredText
61 lines
1.1 KiB
ReStructuredText
.. -*- coding: utf-8; mode: rst -*-
|
|
|
|
.. _DMX_GET_EVENT:
|
|
|
|
=============
|
|
DMX_GET_EVENT
|
|
=============
|
|
|
|
Name
|
|
----
|
|
|
|
DMX_GET_EVENT
|
|
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. c:function:: int ioctl( int fd, DMX_GET_EVENT, struct dmx_event *ev)
|
|
:name: DMX_GET_EVENT
|
|
|
|
|
|
Arguments
|
|
---------
|
|
|
|
``fd``
|
|
File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
|
|
|
|
``ev``
|
|
Pointer to the location where the event is to be stored.
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
This ioctl call returns an 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.
|
|
|
|
|
|
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.
|