IFaxJob::SetStatus method (faxcom.h)

Call the IFaxJob::SetStatus method to pause, resume, cancel, or restart a specified fax job.

Syntax

HRESULT SetStatus(
  [in] long Command
);

Parameters

[in] Command

Type: LONG

Specifies a LONG variable that indicates the job command to perform. This parameter can be one of the following values.

JC_DELETE (JC_DELETE)

Cancel the specified fax job. The job can be active or queued.

JC_PAUSE (JC_PAUSE)

Pause the specified queued fax job. If the fax job is active, the fax service pauses the job when it returns to the queued state.

JC_RESUME (JC_RESUME)

Resume the paused fax job.

JC_RESTART (JC_RESTART)

Restart the specified fax job.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

You can use the IFaxJob::get_QueueStatus property to retrieve the job queue status of 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 faxcom.h
DLL Faxcom.dll

See also

Fax Service Client API Interfaces

Fax Service Client API for Windows 2000

IFaxJob

IFaxJob::get_QueueStatus

IFaxJobs

Managing Fax Jobs