IFaxOutgoingJob::Cancel method (faxcomex.h)
The IFaxOutgoingJob::Cancel method cancels the outbound fax job.
Syntax
HRESULT Cancel();
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Remarks
When you cancel a job that is not part of a broadcast or when you cancel an entire broadcast, the Count property is updated to reflect the change in the number of outgoing jobs. However, if you cancel a single fax from a broadcast, the Count property does not reflect the change. The canceled fax remains in the outgoing queue, so that you can view the status of all faxes from the broadcast.
To use this method, a user must have the farSUBMIT_LOW or farMANAGE_JOBS access right. With the farSUBMIT_LOW access right, users will be able to use this method only for their own faxes. With the farMANAGE_JOBS access right, users will be able to use this method for all faxes on the server.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | faxcomex.h |
| DLL | Fxscomex.dll |