Share via

3.2.4.2.34.16 Run (Opnum 26)

  • Article

The Run method queues a Running Job to the Running Report Job Queue.

 [id(FSRM_DISPID_REPORT_JOB | 0x03)] HRESULT Run(
   [in] FsrmReportGenerationContext context
 );

context: Contains the value of the report generation context in which the associated running report task will run.

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

Return value/code

Description

0x8004530E

FSRM_E_REQD_PARAM_MISSING

The report job does not contain reports to run.

0x80045333

FSRM_E_REPORT_JOB_ALREADY_RUNNING

The report job is already running. (A Running Job (section 3.2.1.5.1.3) has already been created for this report job.)

0x80070057

E_INVALIDARG

The context parameter is not a valid FsrmReprotGenerationContext (section 2.2.1.2.15) value.

The server MUST perform the following actions or return a non-zero error code:

  • If any Report Job.Reports in this report job has its Report.Deprecated property set to true, the server MUST return FSRM_E_NOT_FOUND.

  • If there is already a Running Job in the Running Report Job Queue with the same Task name as this instance's Task name, the server MUST return FSRM_E_REPORT_JOB_ALREADY_RUNNING.

  • Create a Running Job and set its properties as follows:

    • Running Job.Parent: reference to this instance

    • Reports directory: file system path to the output directory associated with context. See section 3.2.1.5.3 for details on selecting the output directory for different generation contexts.

    • Running Job.Cancel: false.

    • Queue the Running Job to Running Report Job Queue.

See section 3.2.1.12.1 for more information about how the server monitors running report tasks.