FPCAlerts Collection
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.
.png "Dd435924.bkbutton(en-us,MSDN.10).png")
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.
Methods
The FPCAlerts collection defines the following methods.
| Method | Description |
|---|---|
Creates a new FPCAlert object in the collection and returns a reference to it. |
|
Creates a new FPCAlert object with a specified storage name in the collection and returns a reference to it. |
|
Retrieves the requested FPCAlert object from the collection. |
|
Removes the specified FPCAlert object from the collection. |
Properties
The FPCAlerts collection defines the following properties.
| Property | Description |
|---|---|
Gets an enumerator object for the collection. |
|
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
| 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
Send comments about this topic to Microsoft
Build date: 6/30/2010