NAME
          irInterrupt - send an interrupt event to an IRAPI process

     SYNOPSIS
          #include <irapi.h>

          int irInterrupt (int channel, int event_id, int mod1, int
          mod2, int mod3);

     DESCRIPTION
          irInterrupt(3IRAPI) may be used to send an interrupt event
          to the current owner(s) of channel. Currently supported
          values for event_id are IRE_SOFTINT and IRE_SOFTDISC The
          mod1 through mod3 values will be passed to the receiving
          application as corresponding event modifiers (see
          IrEVENTS(4IRAPI)).  (NOTE: When the IRE_SOFTINT and
          IRE_SOFTDISC events are sent to a TSM script, they trigger
          the EDIPINT and ESOFTDISC script events [see event()
          instruction], respectively.  Only mod1 and mod2 values will
          be passed to TSM scripts when these interrupts are sent to
          TSM.  They are placed in the r.1 and r.2 script registers,
          respectively.)  How the receiving processes respond to these
          events is determined by the event mask setting for these
          events (see irEvent(3IRAPI)).

     EVENT
          No event results from the call to irInterrupt.

     RETURN VALUE
          The irInterrupt function returns:

          IRR_OK if the request is successful.

          IRR_FAIL if an error occurs.

     ERROR
          irError is set as follows if an error occurs:

          IRER_INVALID if an invalid argument is passed

          IRER_SYSERROR if a system error occurs (irSysError is set to
          the corresponding errno)

     SEE ALSO
          irExec(3IRAPI), irSubProg(3IRAPI),
          irEvent(3IRAPI) IrDEFINES(4IRAPI), IrEVENTS(4IRAPI),
          IrPARAMETERS(4IRAPI)

     VERSION
          This is version 11/25/02 of this man page.