IFsrmReportJob interface (fsrmreports.h)
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:
Inheritance
The IFsrmReportJob interface inherits from IFsrmObject. IFsrmReportJob also has these types of members:
Methods
The IFsrmReportJob interface has these methods.
| IFsrmReportJob::Cancel Cancels the running reports for this report job. |
| IFsrmReportJob::CreateReport Creates a new report object of the specified type. |
| IFsrmReportJob::EnumReports Enumerates all the reports configured for this report job. |
| IFsrmReportJob::get_Formats Retrieves or sets an array of formats that determine the content format of the reports. (Get) |
| IFsrmReportJob::get_LastError Retrieves the error message from the last time the reports were run. |
| IFsrmReportJob::get_LastGeneratedInDirectory Retrieves the local directory path where the reports were stored the last time the reports were run. |
| IFsrmReportJob::get_LastRun Retrieves the time stamp for when the reports were last run. |
| IFsrmReportJob::get_MailTo Retrieves or sets the email addresses of those that will receive the reports via email. (Get) |
| IFsrmReportJob::get_NamespaceRoots Retrieves or sets an array of local directory paths that will be scanned when the report job is run. (Get) |
| IFsrmReportJob::get_RunningStatus Retrieves the running status of the report job. |
| IFsrmReportJob::get_Task Retrieves or sets the name of the report job. (Get) |
| IFsrmReportJob::put_Formats Retrieves or sets an array of formats that determine the content format of the reports. (Put) |
| IFsrmReportJob::put_MailTo Retrieves or sets the email addresses of those that will receive the reports via email. (Put) |
| IFsrmReportJob::put_NamespaceRoots Retrieves or sets an array of local directory paths that will be scanned when the report job is run. (Put) |
| IFsrmReportJob::put_Task Retrieves or sets the name of the report job. (Put) |
| IFsrmReportJob::Run Runs all the reports in the job. |
| IFsrmReportJob::WaitForCompletion Waits for the reports in the job to complete. |
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
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows Server 2008 |
| Target Platform | Windows |
| Header | fsrmreports.h (include FsrmPipeline.h, FsrmQuota.h, FsrmReports.h, FsrmScreen.h) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for