xref: /linux/Documentation/userspace-api/media/dvb/ca-get-descr-info.rst (revision 3503d56cc7233ced602e38a4c13caa64f00ab2aa)
1.. Permission is granted to copy, distribute and/or modify this
2.. document under the terms of the GNU Free Documentation License,
3.. Version 1.1 or any later version published by the Free Software
4.. Foundation, with no Invariant Sections, no Front-Cover Texts
5.. and no Back-Cover Texts. A copy of the license is included at
6.. Documentation/userspace-api/media/fdl-appendix.rst.
7..
8.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10.. _CA_GET_DESCR_INFO:
11
12=================
13CA_GET_DESCR_INFO
14=================
15
16Name
17----
18
19CA_GET_DESCR_INFO
20
21
22Synopsis
23--------
24
25.. c:function:: int  ioctl(fd, CA_GET_DESCR_INFO, struct ca_descr_info *desc)
26    :name: CA_GET_DESCR_INFO
27
28Arguments
29---------
30
31``fd``
32  File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
33
34``desc``
35  Pointer to struct :c:type:`ca_descr_info`.
36
37Description
38-----------
39
40Returns information about all descrambler slots.
41
42Return Value
43------------
44
45On success 0 is returned, and :c:type:`ca_descr_info` is filled.
46
47On error -1 is returned, and the ``errno`` variable is set
48appropriately. The generic error codes are described at the
49:ref:`Generic Error Codes <gen-errors>` chapter.
50