FaxDevAbortOperation function (faxdev.h)

The fax service calls the FaxDevAbortOperation function to request that the fax service provider (FSP) terminate the active fax operation for the fax job specified by the FaxHandle parameter. Each FSP must export the FaxDevAbortOperation function.

Syntax

BOOL FaxDevAbortOperation(
  [in] HANDLE FaxHandle
);

Parameters

[in] FaxHandle

Type: HANDLE

Specifies a fax handle returned by the FaxDevStartJob function.

Return value

Type: BOOL

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero. To get extended error information, the fax service calls GetLastError.

Remarks

The FaxDevAbortOperation function is called asynchronously on an execution thread that is independent of the fax operation. It is usually necessary to synchronize access by multiple threads. For more information, see Synchronizing Execution of Multiple Threads.

FaxDevAbortOperation should return after posting the abort request, rather than wait for the fax operation to end before returning.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	faxdev.h

See also

Fax Service Provider Functions

FaxDevEndJob

FaxDevStartJob

Using the Fax Service Provider API