IFsrmReportJob interface

Used to configure a report job. The job specifies a set of directories that will be scanned to generate one or more different type of reports. The reports help the administrator analyze how the storage is used. The job may also be associated with a scheduled task that will trigger report generation.

To create this interface, call the IFsrmReportManager::CreateReportJob method.

The following methods return this interface:

Members

The IFsrmReportJob interface inherits from IFsrmObject. IFsrmReportJob also has these types of members:

Methods

The IFsrmReportJob interface has these methods.

MethodDescription
Cancel

Cancels the running reports.

CreateReport

Creates a report object of the specified type.

EnumReports

Enumerates all the reports configured for this report job.

Run

Runs all the reports in the job.

WaitForCompletion

Waits for the reports in the job to complete.

 

Properties

The IFsrmReportJob interface has these properties.

PropertyAccess typeDescription

Formats

Read/write

Retrieves or sets an array of formats which determine the content format of the reports.

LastError

Read-only

Retrieves the error message from the last time the reports were run.

LastGeneratedInDirectory

Read-only

Retrieves the local directory path where the reports were stored the last time the reports were run.

LastRun

Read-only

Retrieves the time stamp for when the reports were last run.

MailTo

Read/write

Retrieves or sets the email addresses of those that will receive the reports via email.

NamespaceRoots

Read/write

Retrieves or sets an array of local directory paths that will be scanned when the report job is run.

RunningStatus

Read-only

Retrieves the running status of the report job.

Task

Read/write

Retrieves or sets the name of the report job.

 

Remarks

To commit the job, you must specify at least one report type, at least one namespace root, and the task name.

To run the job, you must specify at least one report type and namespace root.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Header

Fsrm.h (include FsrmPipeline.h, FsrmQuota.h, FsrmReports.h, or FsrmScreen.h)

DLL

SrmSvc.dll

IID

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

 

 

Show:
© 2014 Microsoft. All rights reserved.