ca-get-msg.rst 779 B

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. .. -*- coding: utf-8; mode: rst -*-
  2. .. _CA_GET_MSG:
  3. ==========
  4. CA_GET_MSG
  5. ==========
  6. Name
  7. ----
  8. CA_GET_MSG
  9. Synopsis
  10. --------
  11. .. c:function:: int ioctl(fd, CA_GET_MSG, struct ca_msg *msg)
  12. :name: CA_GET_MSG
  13. Arguments
  14. ---------
  15. ``fd``
  16. File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
  17. ``msg``
  18. Pointer to struct :c:type:`ca_msg`.
  19. Description
  20. -----------
  21. Receives a message via a CI CA module.
  22. .. note::
  23. Please notice that, on most drivers, this is done by reading from
  24. the /dev/adapter?/ca? device node.
  25. Return Value
  26. ------------
  27. On success 0 is returned.
  28. On error -1 is returned, and the ``errno`` variable is set
  29. appropriately.
  30. Generic error codes are described at the
  31. :ref:`Generic Error Codes <gen-errors>` chapter.