Merge branch 'topic/docs-next' into v4l_for_linus
[sfrench/cifs-2.6.git] / Documentation / media / uapi / dvb / video-get-capabilities.rst
1 .. -*- coding: utf-8; mode: rst -*-
2
3 .. _VIDEO_GET_CAPABILITIES:
4
5 ======================
6 VIDEO_GET_CAPABILITIES
7 ======================
8
9 Name
10 ----
11
12 VIDEO_GET_CAPABILITIES
13
14
15 Synopsis
16 --------
17
18 .. cpp:function:: int ioctl(fd, int request = VIDEO_GET_CAPABILITIES, unsigned int *cap)
19
20
21 Arguments
22 ---------
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 VIDEO_GET_CAPABILITIES for this command.
40
41     -  .. row 3
42
43        -  unsigned int \*cap
44
45        -  Pointer to a location where to store the capability information.
46
47
48 Description
49 -----------
50
51 This ioctl call asks the video device about its decoding capabilities.
52 On success it returns and integer which has bits set according to the
53 defines in section ??.
54
55
56 Return Value
57 ------------
58
59 On success 0 is returned, on error -1 and the ``errno`` variable is set
60 appropriately. The generic error codes are described at the
61 :ref:`Generic Error Codes <gen-errors>` chapter.