[deliverable/linux.git] / Documentation / media / uapi / rc / lirc-set-send-carrier.rst

.. -*- coding: utf-8; mode: rst -*-

.. _lirc_set_send_carrier:

***************************
ioctl LIRC_SET_SEND_CARRIER
***************************

Name
====

LIRC_SET_SEND_CARRIER - Set send carrier used to modulate IR TX.


Synopsis
========

.. cpp:function:: int ioctl( int fd, int request, __u32 *frequency )

Arguments
=========

``fd``
    File descriptor returned by open().

``request``
    LIRC_SET_SEND_CARRIER

``frequency``
    Frequency of the carrier to be modulated, in Hz.

Description
===========

Set send carrier used to modulate IR PWM pulses and spaces.


Return Value
============

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
Commit	Line	Data
910f4461 MCC	1	.. -- coding: utf-8; mode: rst --
	2
	3	.. _lirc_set_send_carrier:
	4
	5	***************************
	6	ioctl LIRC_SET_SEND_CARRIER
	7	***************************
	8
	9	Name
	10	====
	11
	12	LIRC_SET_SEND_CARRIER - Set send carrier used to modulate IR TX.
	13
	14
	15	Synopsis
	16	========
	17
	18	.. cpp:function:: int ioctl( int fd, int request, __u32 *frequency )
	19
	20	Arguments
	21	=========
	22
	23	``fd``
	24	File descriptor returned by open().
	25
	26	``request``
	27	LIRC_SET_SEND_CARRIER
	28
	29	``frequency``
	30	Frequency of the carrier to be modulated, in Hz.
	31
	32	Description
	33	===========
	34
	35	Set send carrier used to modulate IR PWM pulses and spaces.
	36
	37
	38	Return Value
	39	============
	40
	41	On success 0 is returned, on error -1 and the ``errno`` variable is set
	42	appropriately. The generic error codes are described at the
	43	:ref:`Generic Error Codes <gen-errors>` chapter.