NAME
          irFAXRecord - record a FAX to a file.

     SYNOPSIS
          #include <irapi.h>

          int irFAXRecord (channel_id cid, int tag, int count, const
          char *file);

     DESCRIPTION
          The function irFAXRecord records a FAX image to a file iden-
          tified through file, cid is the channel id for which FAX
          recording is intended and tag is an (24-bit) arbitrary value
          to be returned with the subsequent IRE_FAXRECORD_DONE event.
          count is the number of bytes to be recorded.  If count less
          than or equal to zero, any number of bytes, limited to to
          system limitations, are recorded.  The FAX image is stored
          in file as a TIFF 6.0 image.

          When the FAX recording function returns successfully, the
          library moves to the IRS_FAXRECORDING or
          IRS_FAXRECORD_PENDING state depending upon FAX resource
          availability.  The library must be in the IRS_IDLE state
          when the function is invoked and will remain in the IRS_IDLE
          state if irFAXRecord returns with an error.

          If irStop(3IRAPI) is called from the IRS_FAXRECORDING or
          IRS_FAXRECORD_PENDING state, the FAX request will be ter-
          minated.  Applications must wait for IRE_FAXRECORD_DONE.

     EVENTS
          A IRE_FAXRECORD_DONE event is generated when FAX recording
          terminates.  Event_mod1 will contain the FAX completion
          status.

     RETURN VALUE
          IRR_OK is returned if the request is successful.

          IRR_PENDING is returned if FAX resources could not be
          immediately allocated.  See irIntro(3IRAPI) for a discussion
          of what conditions may lead to a return code of IRR_PENDING.

          IRR_FAIL is returned if an error occurs.

     ERROR
          irError is set as follows if an error occurs:

          IRER_INVALID if the cid is invalid or if file is the NULL
          pointer

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

          IRER_RTU_BUSY if the required Feature License's are all in
          use and IRP_RESOURCE_RETURNMODE is set to IRD_IMMEDIATE

          IRER_NO_RTU if no Feature License has been purchased for
          this function

          IRER_RESOURCEBUSY if there are no resources available and
          IRP_RESOURCE_RETURNMODE is set to IRD_IMMEDIATE

          IRER_BADSTATE if the channel is not in the IRS_IDLE state

          IRER_NORESOURCES if there are no resources in existence

          IRER_RESTRICTED if the channel is restricted from using the
          required resources

     SEE ALSO
          IrEVENTS(4IRAPI).

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