projects / deliverable / linux.git / blame
| Commit | Line | Data |
|---|---|---|
| 47d23e36 MCC |
1 | .. -*- coding: utf-8; mode: rst -*- |
| 2 | ||
| 3 | .. _DMX_SET_FILTER: | |
| 4 | ||
| 586027ce | 5 | ============== |
| 47d23e36 MCC |
6 | DMX_SET_FILTER |
| 7 | ============== | |
| 8 | ||
| 15e7d615 | 9 | Name |
| 586027ce | 10 | ---- |
| 47d23e36 | 11 | |
| 586027ce | 12 | DMX_SET_FILTER |
| 47d23e36 | 13 | |
| 15e7d615 MCC |
14 | |
| 15 | Synopsis | |
| 47d23e36 MCC |
16 | -------- |
| 17 | ||
| 5929cb17 | 18 | .. cpp:function:: int ioctl( int fd, int request = DMX_SET_FILTER, struct dmx_sct_filter_params *params) |
| 47d23e36 | 19 | |
| 47d23e36 | 20 | |
| 15e7d615 | 21 | Arguments |
| 586027ce | 22 | --------- |
| 47d23e36 MCC |
23 | |
| 24 | .. flat-table:: | |
| 25 | :header-rows: 0 | |
| 26 | :stub-columns: 0 | |
| 27 | ||
| 28 | ||
| 29 | - .. row 1 | |
| 30 | ||
| 31 | - int fd | |
| 32 | ||
| 33 | - File descriptor returned by a previous call to open(). | |
| 34 | ||
| 35 | - .. row 2 | |
| 36 | ||
| 37 | - int request | |
| 38 | ||
| 39 | - Equals DMX_SET_FILTER for this command. | |
| 40 | ||
| 41 | - .. row 3 | |
| 42 | ||
| 43 | - struct dmx_sct_filter_params \*params | |
| 44 | ||
| 45 | - Pointer to structure containing filter parameters. | |
| 46 | ||
| 47 | ||
| 15e7d615 | 48 | Description |
| 586027ce MCC |
49 | ----------- |
| 50 | ||
| 51 | This ioctl call sets up a filter according to the filter and mask | |
| 52 | parameters provided. A timeout may be defined stating number of seconds | |
| 53 | to wait for a section to be loaded. A value of 0 means that no timeout | |
| 54 | should be applied. Finally there is a flag field where it is possible to | |
| 55 | state whether a section should be CRC-checked, whether the filter should | |
| 56 | be a ”one-shot” filter, i.e. if the filtering operation should be | |
| 57 | stopped after the first section is received, and whether the filtering | |
| 58 | operation should be started immediately (without waiting for a | |
| 59 | DMX_START ioctl call). If a filter was previously set-up, this filter | |
| 60 | will be canceled, and the receive buffer will be flushed. | |
| 61 | ||
| 62 | ||
| 15e7d615 | 63 | Return Value |
| 47d23e36 MCC |
64 | ------------ |
| 65 | ||
| 66 | On success 0 is returned, on error -1 and the ``errno`` variable is set | |
| 67 | appropriately. The generic error codes are described at the | |
| 68 | :ref:`Generic Error Codes <gen-errors>` chapter. |