| .. -*- coding: utf-8; mode: rst -*- |
| |
| .. _FE_GET_EVENT: |
| |
| ************ |
| FE_GET_EVENT |
| ************ |
| |
| Name |
| ==== |
| |
| FE_GET_EVENT |
| |
| |
| Synopsis |
| ======== |
| |
| .. cpp:function:: int ioctl(int fd, int request = QPSK_GET_EVENT, struct dvb_frontend_event *ev) |
| |
| |
| Arguments |
| ========= |
| |
| .. 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` 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. |
| |
| |
| 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. |
| |
| |
| 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. |
