PFAXABORT callback function (winfax.h)
A fax client application calls the FaxAbort function to terminate a fax job.
Syntax
PFAXABORT Pfaxabort;
BOOL Pfaxabort(
[in] HANDLE FaxHandle,
[in] DWORD JobId
)
{...}
Parameters
[in] FaxHandle
Type: HANDLE
Specifies a fax server handle returned by a call to the FaxConnectFaxServer function.
[in] JobId
Type: DWORD
Specifies a unique number that identifies the fax job to terminate.
Return value
Type: BOOL
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error information, call GetLastError. GetLastError can return one of the following errors.
| Return code | Description |
|---|---|
|
Access is denied. You must own the job, or have FAX_JOB_MANAGE access. |
|
The FaxHandle parameter is invalid. |
|
The JobId parameter is invalid. |
Remarks
An application typically calls the FaxAbort function to terminate a fax transmission that is in progress. To manage a queued fax job, an application typically calls the FaxSetJob function. FaxSetJob can cancel an active job; the function can also pause, resume, cancel, or restart a queued fax job.
Call the FaxEnumJobs function to retrieve a valid value to use in the JobId parameter.
For more information, see Modifying a Fax Job and Terminating a Fax Job.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | winfax.h |
See also
Fax Service Client API Functions