FaxMan SDK Version 4.7
FaxCancel

BOOL FaxCancel(PAPPINFO pApp, DWORD dwID)

 

Cancels a send or receive operation that is currently in progress.

 

Parameter

Type/Description

pApp

PAPPINFO Returned from FaxRegisterApp

dwID

DWORD Unique id of the fax to cancel.

 

Return Value

Returns FAX_OK (0) on successful cancel, FAX_ERR_INVFAXID (-14) otherwise.

 

Comments

The dwID is the return value from FaxSchedule for transmitted faxes. For received faxes, the dwID value is passed as part of the receive event notifications.

 

This function should only be used to cancel a fax that is in progress. If the fax is still in the pending log, you should use the LogDelete function.

 

If a sending fax is cancelled, it is moved immediately to the failed log, regardless of the number of retries requested.

 

NOTE

Cancelling a fax does not necessarily cause it to stop immediately. The faxmodem must be shut down in an orderly fashion, otherwise the phone line may be left off-hook. The process may take anywhere from a fraction of a second to several seconds, depending on the faxmodem and where in the faxing process the cancel was requested.

 

 


© 2013 Data Techniques, Inc. All Rights Reserved.

Send comments on this topic.