NAME
          irDial - dial a dial string

     SYNOPSIS
          #include <irapi.h>

          int irDial (channel_id cid, int tag, const char
          *dial_string);

     DESCRIPTION
          The irDial function dials dial_string on the channel speci-
          fied by cid.  The cid must be in the IRD_ACTIVE service
          state before using irDial.

          Tag is a user-supplied number that associates the irDial
          with a subsequent event.

          The valid values for dial_string are listed in
          IrDIALSTRINGS(4IRAPI).

          IRAPI library parameter IRP_OUTCALL_DIALTYPE [see
          IrPARAMETERS(4IRAPI)] defines type of dialing to be used.
          The possible dialing types are IRD_DIALTYPE_DP (dial pulse),
          IRD_DIALTYPE_TT (touch tone) and IRD_DIALTYPE_MF (multiple
          frequency; for future use only).  Not all dialing types are
          supported by all telephony types.  The current dialing type
          can be retrieved using irGetParam(3IRAPI) while a new value
          can be assigned to it using irSetParam(3IRAPI).  For digital
          interfaces, the default IRP_OUTCALL_DIALTYPE is
          IRD_DIALTYPE_TT and cannot currently be changed.  For TR and
          other analog interfaces, the Type of Signaling value from
          the Analog Interfaces screen (refer to "Switch Interface
          Administration" in Intuity CONVERSANT VIS V5.0 Operations,
          585-310-550) is used as the default.  This parameter must be
          set to the desired value before invoking irDial. irDial uses
          the value available at the time of placing the outcall.

          The maximum length of the dial string depends on the
          telephony type.  Currently all digital interfaces have a
          maximum dial string length of 15 characters.  Applications
          that wish to pass more than 15 characters should use multi-
          ple irDial requests.

          WARNING: The IRP_OUTCALL_DIALTYPE parameter must be changed
          before calling irDial or after receiving the IRE_DIAL_DONE
          event.  Changing it while dialing is in progress can lead to
          unexpected results.

     EVENT
          The IRE_DIAL_DONE event is generated by irDial when dialing
          is completed.

     RETURN VALUE
          IRR_OK is returned if request is successfully initiated.

          IRR_FAIL is returned if an error occurs.

     ERROR
          irError is set as follows if an error occurs:

          IRER_INVALID if the dial_string is too long or otherwise
          invalid or if the cid is invalid

          IRER_BADSTATE if the cid is not in the IRS_IDLE library
          state

          IRER_SERVICESTATE if the cid is not in the IRD_ACTIVE ser-
          vice state

          IRER_DRIVER_ERROR if a driver call failure occurs (see
          irSysError for additional information)

          IRER_SYSERROR if a system or driver call failure occurs (see
          irSysError for additional information)

     CAVEAT
          This function does not originate an outbound call on any
          telephony connections.  Applications should use irCall to
          originate calls for generic channels.  This function can be
          used to generate DTMF digits on any trunk type after a call
          has been set up.  Applications using IRD_DIALTYPE_DP should
          be aware that this dial type may be inappropriate for active
          channels.

     SEE ALSO
          irCall(3IRAPI), irSetParam(3IRAPI), irGetParam(3IRAPI),
          IrPARAMETERS(4IRAPI), IrEVENTS(4IRAPI)

     VERSION
          This is version 8/31/00 of this man page.