3.2.4.2.34.18 Cancel (Opnum 28)

The Cancel method stops the associated Running Job (section 3.2.1.5.1.3), if any, from continuing and returns S_OK upon successful completion.

 [id(FSRM_DISPID_REPORT_JOB | 0x05)] HRESULT Cancel();

This method has no parameters.

Return Values: The method MUST return zero on success, or a nonzero error code on failure.

The Running Job whose Running Job.Parent in the Running Report Job Queue whose Task name is equivalent to the Task name of this instance will be referred to as the associated running job.

The server MUST stop the associated Running Job as follows, or return a nonzero error code:

  • If there is no associated Running Job in the Running Report Job Queue, the server MUST return zero.

  • If an associated Running Job exists, set the Running Job.Cancel property of the associated Running Job to true.

See section 3.2.1.12.1 for details on how to associate a Running Report Task with a Report job.