0001 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
0002 .. c:namespace:: DTV.ca
0003
0004 .. _CA_GET_MSG:
0005
0006 ==========
0007 CA_GET_MSG
0008 ==========
0009
0010 Name
0011 ----
0012
0013 CA_GET_MSG
0014
0015 Synopsis
0016 --------
0017
0018 .. c:macro:: CA_GET_MSG
0019
0020 ``int ioctl(fd, CA_GET_MSG, struct ca_msg *msg)``
0021
0022 Arguments
0023 ---------
0024
0025 ``fd``
0026 File descriptor returned by a previous call to :c:func:`open()`.
0027
0028 ``msg``
0029 Pointer to struct :c:type:`ca_msg`.
0030
0031 Description
0032 -----------
0033
0034 Receives a message via a CI CA module.
0035
0036 .. note::
0037
0038 Please notice that, on most drivers, this is done by reading from
0039 the /dev/adapter?/ca? device node.
0040
0041 Return Value
0042 ------------
0043
0044 On success 0 is returned.
0045
0046 On error -1 is returned, and the ``errno`` variable is set
0047 appropriately.
0048
0049 Generic error codes are described at the
0050 :ref:`Generic Error Codes <gen-errors>` chapter.
