projects / deliverable / linux.git / blame
| Commit | Line | Data |
|---|---|---|
| 47d23e36 MCC |
1 | .. -*- coding: utf-8; mode: rst -*- |
| 2 | ||
| 3 | .. _DMX_GET_EVENT: | |
| 4 | ||
| 586027ce | 5 | ============= |
| 47d23e36 MCC |
6 | DMX_GET_EVENT |
| 7 | ============= | |
| 8 | ||
| 15e7d615 | 9 | Name |
| 586027ce | 10 | ---- |
| 47d23e36 | 11 | |
| 586027ce | 12 | DMX_GET_EVENT |
| 47d23e36 | 13 | |
| 15e7d615 MCC |
14 | |
| 15 | Synopsis | |
| 47d23e36 MCC |
16 | -------- |
| 17 | ||
| cf8076c3 MCC |
18 | .. c:function:: int ioctl( int fd, DMX_GET_EVENT, struct dmx_event *ev) |
| 19 | :name: DMX_GET_EVENT | |
| 47d23e36 | 20 | |
| 47d23e36 | 21 | |
| 15e7d615 | 22 | Arguments |
| 586027ce | 23 | --------- |
| 47d23e36 | 24 | |
| cf8076c3 MCC |
25 | ``fd`` |
| 26 | File descriptor returned by :c:func:`open() <dvb-dmx-open>`. | |
| 47d23e36 | 27 | |
| cf8076c3 MCC |
28 | ``ev`` |
| 29 | Pointer to the location where the event is to be stored. | |
| 47d23e36 MCC |
30 | |
| 31 | ||
| 15e7d615 | 32 | Description |
| 586027ce MCC |
33 | ----------- |
| 34 | ||
| 35 | This ioctl call returns an event if available. If an event is not | |
| 36 | available, the behavior depends on whether the device is in blocking or | |
| 37 | non-blocking mode. In the latter case, the call fails immediately with | |
| 38 | errno set to ``EWOULDBLOCK``. In the former case, the call blocks until an | |
| 39 | event becomes available. | |
| 40 | ||
| 41 | ||
| 15e7d615 | 42 | Return Value |
| 47d23e36 MCC |
43 | ------------ |
| 44 | ||
| 45 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
| 46 | appropriately. The generic error codes are described at the | |
| 47 | :ref:`Generic Error Codes <gen-errors>` chapter. | |
| 48 | ||
| 49 | ||
| 50 | ||
| 51 | .. flat-table:: | |
| 52 | :header-rows: 0 | |
| 53 | :stub-columns: 0 | |
| 54 | ||
| 55 | ||
| 56 | - .. row 1 | |
| 57 | ||
| 58 | - ``EWOULDBLOCK`` | |
| 59 | ||
| 60 | - There is no event pending, and the device is in non-blocking mode. |