Share via


FsrmReportSchedulerClass Class

 

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

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

Inheritance Hierarchy

System.Object
  Microsoft.Storage.FsrmReportSchedulerClass

Syntax

[ClassInterfaceAttribute(0)]
[GuidAttribute("EA25F1B8-1B8D-4290-8EE8-E17C12C2FE20")]
public class FsrmReportSchedulerClass : IFsrmReportScheduler, 
    FsrmReportScheduler
[ClassInterfaceAttribute(0)]
[GuidAttribute("EA25F1B8-1B8D-4290-8EE8-E17C12C2FE20")]
public ref class FsrmReportSchedulerClass : IFsrmReportScheduler, 
    FsrmReportScheduler
[<ClassInterfaceAttribute(0)>]
[<GuidAttribute("EA25F1B8-1B8D-4290-8EE8-E17C12C2FE20")>]
type FsrmReportSchedulerClass = 
    class
        interface IFsrmReportScheduler
        interface FsrmReportScheduler
    end
<ClassInterfaceAttribute(0)>
<GuidAttribute("EA25F1B8-1B8D-4290-8EE8-E17C12C2FE20")>
Public Class FsrmReportSchedulerClass
    Implements IFsrmReportScheduler, FsrmReportScheduler

Constructors

Name Description
System_CAPS_pubmethod FsrmReportSchedulerClass()

Creates a new instance of the FsrmReportSchedulerClass object.

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 Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ModifyScheduleTask(String, Object, String)

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

System_CAPS_pubmethod ToString()

(Inherited from Object.)

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 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.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

IFsrmReportScheduler
Microsoft.Storage Namespace

Return to top