IFsrmReportScheduler Interface

 

Used to manage scheduled tasks for report jobs and file management jobs.

Namespace:   Microsoft.Storage
Assembly:  srmlib (in srmlib.dll)

Syntax

[GuidAttribute("6879CAF9-6617-4484-8719-71C3D8645F94")]
public interface IFsrmReportScheduler
[GuidAttribute("6879CAF9-6617-4484-8719-71C3D8645F94")]
public interface class IFsrmReportScheduler
[<GuidAttribute("6879CAF9-6617-4484-8719-71C3D8645F94")>]
type IFsrmReportScheduler = interface end
<GuidAttribute("6879CAF9-6617-4484-8719-71C3D8645F94")>
Public Interface IFsrmReportScheduler

Methods

Name Description
System_CAPS_pubmethod CreateScheduleTask(String, Object, String)

Creates a scheduled task that is used to trigger a report job.

System_CAPS_pubmethod DeleteScheduleTask(String)

Deletes a task that is used to trigger a report job.

System_CAPS_pubmethod ModifyScheduleTask(String, Object, String)

Modifies a task that is used to trigger a report job.

System_CAPS_pubmethod VerifyNamespaces(Object)

Verifies that the specified local directory paths that are used as the source for the reports are valid.

Remarks

To get this interface, call the CoCreateInstanceEx function. Use CLSID_FsrmReportScheduler as the class identifier and __uuidof(IFsrmReportScheduler) as the interface identifier. For an example, see Scheduling a Report Job.

To enumerate the schedules for reports, call the EnumReportJobs method. Use the task name in the Task property to retrieve the schedule from the Task Scheduler. To retrieve the schedule, call the ITaskScheduler::Activate method. (FSRM supports only Task Scheduler version 1.0, not version 2.0.) Note that some report jobs may not have an associated schedule.

To enumerate the schedules for file management jobs, call the EnumFileManagementJobs method. Use the task name in the Task property to retrieve the schedule from the Task Scheduler. To retrieve the schedule, call the ITaskScheduler::Activate method.To create this object from a script, use the "Fsrm.FsrmReportScheduler" program identifier.

See Also

FsrmReportScheduler
Microsoft.Storage Namespace

Return to top