IFsrmReportJob::Run method

Runs all the reports in the job.

Syntax


HRESULT Run(
  [in] FsrmReportGenerationContext context
);

Parameters

context [in]

Specifies to which subdirectory the reports are written. For possible values, see the FsrmReportGenerationContext enumeration.

Return value

The method returns the following return values.

S_OK

Success

FSRM_E_REPORT_JOB_ALREADY_RUNNING

The report job is already running or is queued to run.

FSRM_E_REQD_PARAM_MISSING

The report job does not contain reports to run.

E_INVALIDARG

The context is not valid.

Remarks

Note that reports that run in the scheduled context remain in the queue for five minutes before they are run; reports that run in the other contexts remain in the queue for 30 seconds.

If you call this method and the report job is already queued or running, the method returns an error. To determine the status of the job, access the IFsrmReportJob::RunningStatus property.

Examples

For an example, see Running a Report Job.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Header

FsrmReports.h

DLL

SrmSvc.dll

IID

IID_IFsrmReportJob is defined as 38e87280-715c-4c7d-a280-ea1651a19fef

See also

IFsrmReportJob
IFsrmReportJob::WaitForCompletion

 

 

Show: