Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/hid
[cascardo/linux.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 .. attention:: This ioctl is deprecated.
15
16 Synopsis
17 --------
18
19 .. c:function:: int ioctl(fd, VIDEO_GET_CAPABILITIES, unsigned int *cap)
20     :name: VIDEO_GET_CAPABILITIES
21
22
23 Arguments
24 ---------
25
26 .. flat-table::
27     :header-rows:  0
28     :stub-columns: 0
29
30
31     -  .. row 1
32
33        -  int fd
34
35        -  File descriptor returned by a previous call to open().
36
37     -  .. row 2
38
39        -  int request
40
41        -  Equals VIDEO_GET_CAPABILITIES for this command.
42
43     -  .. row 3
44
45        -  unsigned int \*cap
46
47        -  Pointer to a location where to store the capability information.
48
49
50 Description
51 -----------
52
53 This ioctl call asks the video device about its decoding capabilities.
54 On success it returns and integer which has bits set according to the
55 defines in section ??.
56
57
58 Return Value
59 ------------
60
61 On success 0 is returned, on error -1 and the ``errno`` variable is set
62 appropriately. The generic error codes are described at the
63 :ref:`Generic Error Codes <gen-errors>` chapter.