FPCAlerts collection

Applies to: desktop apps only

The FPCAlerts collection holds a set of FPCAlert objects that represent all of the alerts that are defined for a Forefront TMG array. Each object within this collection specifies the actions to be taken in response to a specific event. Each FPCAlert object also defines the three thresholds that determine when the actions will be taken. With alerts, an administrator can be notified when certain events take place and decide which actions should be taken in advance.

The FPCAlerts collection is accessed through the Alerts property of an FPCArray object.

Click here to see the Forefront TMG object hierarchy.

Inheritance

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

Members

The FPCAlerts collection has these types of members:

• Methods
• Properties

Methods

The FPCAlerts collection has these methods.

Method	Description
Add	Creates a new FPCAlert object in the collection and returns a reference to it.
AddWithStorageName	Creates a new FPCAlert object with a specified storage name in the collection and returns a reference to it.
Item	Retrieves the requested FPCAlert object from the collection.
Remove	Removes the specified FPCAlert object from the collection.

 

Properties

The FPCAlerts collection has these properties.

Property	Access type	Description
_NewEnum	Read-only	Gets an enumerator object for the collection.
Count	Read-only	Gets the number of FPCAlert objects in the collection.

 

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	Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML document.
ExportToFile	Recursively writes the stored values of all the properties of the object and its subobjects 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	Recursively copies the values of all the properties of the object and of its subobjects from the specified XML document to persistent storage.
ImportFromFile	Recursively copies the values of all the properties of the object and of its subobjects 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	Recursively reads the values of all the properties of the object and of its subobjects from persistent storage, overwriting any changes that have not been saved.
Save	Recursively writes the current values of all the properties of the object and its subobjects 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 collection that can hold sets of custom data for extending the object.

 

Interfaces for C++ Programming

This collection implements the IFPCAlerts interface.

Requirements

Minimum supported client	Windows Vista, None supported
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
IDL	Msfpccom.idl

See also

COM Objects

 

 

Build date: 7/12/2010