NAME irFAXOutOfCall - queue a FAX print request for out of call delivery. SYNOPSIS #include <irapi.h> int irFAXOutOfCall (channel_id cid, const ir_fax_delivery *params, char * const job_id); DESCRIPTION The function irFAXOutOfCall initiates a FAX request for delivery out of call. The FAX to be delivered is specified through prior calls to irFAXPrint(3IRAPI). params points to a ir_fax_delivery structure which contains the FAX delivery parameters as follows: typedef struct { const char *destination; const char *comments; const char *tsi; time_t delivery_time; int retry_time; int retry_count; const char *command; } ir_fax_delivery; Where destination is a dial string specifying the target of the FAX delivery. The valid values for destination are listed in IrDIALSTRINGS(4IRAPI). A possible future feature is that if destination is IRD_PRINTER, the FAX will be delivered to the UNIX print spooler for printing on the default system printer. comments is arbitrary text to allow the FAX request to be traced from the application to the FAX server. tsi is the international telephone number of the channel printing the FAX or any alphabetic identification no more than 20 characters. delivery_time is a UNIX time stamp specifying some time in the future when the FAX is to be delivered. If delivery_time is less than or equal to the current time or 0, the FAX will be scheduled for immediate delivery. retry_time is the amount of time, measured in seconds, the system should wait between attempted deliveries. retry_count is the maximum number of times the system should attempt to deliver the FAX before failing the request. command is currently not implemented but reserved for future use to be a fully qualified UNIX command line which is automatically executed by the system when the FAX delivery request terminates. Concatenated to the command line is a command line option, either -S or -F indicating success or failure respectively, and the job_id. If command is the NULL pointer, the system will not run any command. irFAXOutOfCall will not attempt to validate command prior to execution. The address pointed to by job_id will be set with the address of the job ID. The job ID may be used for queries on the FAX job or to link execution of the command with the completed FAX job. EVENTS There are no events associated with this command. RETURN VALUE IRR_OK on success IRR_FAIL on error ERROR irError is set as follows if an error occurs: IRER_INVALID if the cid is invalid, destination is the NULL pointer, retry_time or retry_count are less than zero or job_id is the NULL pointer IRER_SYSERROR on system call failure (check irSysError for additional information) IRER_BADSTATE if the cid is not in the IRS_FAXPRINT_QUEUED state. SEE ALSO irFAXPrint(3IRAPI), irEnd(3IRAPI). NOTE The job_id string passed into irFAXOutOfCall should be a minimum of 15 characters long. This job_id string is always NULL terminated. VERSION This is version 7/11/02 of this man page.