NAME
          irGetInput - collect an input string

     SYNOPSIS
          #include <irapi.h>

          int irGetInput (channel_id cid, char *i_buf, int length);

     DESCRIPTION
          The irGetInput function copies the length input characters
          found in the input queue to i_buf for the specified tele-
          phone channel (cid).  The string is terminated with '\0'
          (null character) if the length of the input is less than
          length.  If the length of the input is greater than or equal
          to length, the string will not be terminated with a null
          character.  If the length of the input queue is greater than
          length, the remaining characters are left on the queue.

          The input queue is the facility through which all caller
          supplied input is provided to the application.  Input
          includes touch-tone input and speech recognition input.

          The irGetInput function may retreive a maximum of
          NDIGITS_QUEUE characters, which is the maximum size of the
          input queue.  NDIGITS_QUEUE is defined in
          /usr/include/sys/rm.h

          irGetInput is typically used after a IRE_INPUT_DONE event is
          received indicating that a string has been collected.  The
          IRE_INPUT_DONE event is generated under the following condi-
          tions controlled by IRAPI library parameters [see
          IrPARAMETERS(4IRAPI)] for input collection:

               o Parameter IRP_INPUT_LEN specifies the number of
                 sequential inputs that must be received before
                 IRE_INPUT_DONE event is generated with an event
                 modifier of IREM_INPUT_LENGTH.

               o Parameter IRP_INPUT_DELIM1 or IRP_INPUT_DELIM2 speci-
                 fies a delimiter that, when received as input immedi-
                 ately, causes IRE_INPUT_DONE event to be generated
                 with an event modifier of IREM_INPUT_DELIM.

          Calling irGetInput with length as 0 causes irGetInput to
          return the number of characters currently on the input
          queue.  No characters are removed from the input queue.

     EVENT
          No event results from the call to irGetInput.

     RETURN VALUE
          The number of characters written to i_buf if the request is
          successful.

          IRR_FAIL is returned if an error occurs.

     ERROR
          irError is set as follows if an error occurs:

          IRER_INVALID if the cid is not valid

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

     SEE ALSO
          irUngetInput(3IRAPI), irFlushInput(3IRAPI),
          irStartTTTimer(3IRAPI), and IrEVENTS(4IRAPI)

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