FPCSchedule Object

The FPCSchedule object defines a schedule. A schedule is defined by blocks representing hours that are selected for each day of the week. Each day of the week can have different hour blocks selected. Schedules are used by Forefront TMG to define a set of hours during which a certain configuration detail, such as a policy rule, applies.

The hour blocks used to define a schedule include the specified time and the one-hour period following that time. For example, the hour designated by 2_PM is the one-hour time block between 2:00 P.M. (14:00) and 3 P.M. (15:00).

By default, the following schedules are supplied with Forefront TMG:

• Weekends
• Work hours

The FPCSchedule object representing the schedule that defines the times when a specific rule applies is referenced through the FPCRef object held in the ScheduleUsed property of the applicable FPCPolicyRule object.

The FPCSchedule object is an element of an FPCSchedules collection, and a new object representing a schedule can be created by calling the Add method of this collection.

Click here to see the Forefront TMG object hierarchy.

Inheritance

This object inherits from the FPCPersist object, which contains methods and properties related to the persistent storage of an object's data. They include methods for exporting the object's data to and importing it from an XML document.

Methods

The FPCSchedule object defines the following methods.

Method	Description
IsSet	Returns a Boolean variable indicating whether every hour in the specified set is part of the schedule.
Set	Adds a set of hours to the schedule.
UnSet	Removes a set of hours from the schedule.

Properties

The FPCSchedule object defines the following properties.

Property	Description
Description	Gets or sets the description of the schedule.
Name	Gets or sets the name of the schedule.

Methods Inherited from FPCPersist

Name	Description
CancelWaitForChanges	Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only).
CanImport	Returns a Boolean value that indicates whether the object's properties can be imported from the specified XML document.
Export	Writes the stored values of all of the object's properties to the specified XML document.
ExportToFile	Writes the stored values of all of the object's properties to the specified XML file.
GetServiceRestartMask	Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect.
Import	Copies the values of all of the object's properties from the specified XML document to persistent storage.
ImportFromFile	Copies the values of all of the object's properties from the specified XML file to persistent storage.
LoadDocProperties	Provides the XML document's properties so that you can know what information can be imported from the document.
Refresh	Reads the values of all of the object's properties from persistent storage, overwriting any changes that have not been saved.
Save	Writes the current values of all of the object's properties to persistent storage.
WaitForChanges	Registers to wait for an event indicating that the contents of the object have changed (for use in C and C++ programming only).

Properties Inherited from FPCPersist

Name	Description
PersistentName	Gets the persistent name of the object. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy.
VendorParameterSets	Gets an FPCVendorParametersSets object that can hold sets of custom data for extending the object.

Interfaces for C++ Programming

This collection implements the IFPCSchedule interface.

Requirements

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.

See Also

COM Objects

Send comments about this topic to Microsoft

Build date: 6/30/2010