blob: 446afe89af8268aab83e7842d0b76ce4a46a5a10 [file] [log] [blame]
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -03001.. -*- coding: utf-8; mode: rst -*-
2
3.. _CA_GET_DESCR_INFO:
4
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -03005=================
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -03006CA_GET_DESCR_INFO
7=================
8
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -03009NAME
10----
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030011
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030012CA_GET_DESCR_INFO
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030013
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030014SYNOPSIS
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030015--------
16
17.. cpp:function:: int ioctl(fd, int request = CA_GET_DESCR_INFO, ca_descr_info_t *)
18
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030019
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030020ARGUMENTS
21---------
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030022
23.. flat-table::
24 :header-rows: 0
25 :stub-columns: 0
26
27
28 - .. row 1
29
30 - int fd
31
32 - File descriptor returned by a previous call to open().
33
34 - .. row 2
35
36 - int request
37
38 - Equals CA_GET_DESCR_INFO for this command.
39
40 - .. row 3
41
42 - ca_descr_info_t \*
43
44 - Undocumented.
45
46
Mauro Carvalho Chehab586027c2016-07-05 07:58:48 -030047DESCRIPTION
48-----------
49
50This ioctl is undocumented. Documentation is welcome.
51
52
53RETURN VALUE
Mauro Carvalho Chehab47d23e32016-07-05 10:37:31 -030054------------
55
56On success 0 is returned, on error -1 and the ``errno`` variable is set
57appropriately. The generic error codes are described at the
58:ref:`Generic Error Codes <gen-errors>` chapter.