FPCEventDefinitions collection
Applies to: desktop apps only
The FPCEventDefinitions collection holds a set of FPCEventDefinition objects that represent all of the events defined in an Forefront TMG array. Events describe conditions that may require the attention of an administrator, and predetermined actions can be configured as a response to particular events in an alert (an FPCAlert object). Events can be signaled by Forefront TMG and its extensions (add-ins).
This collection is accessed through the EventDefinitions property of an FPCRuleElements object.
.png "Ff824808.bkbutton(en-us,VS.85).png")
Click here to see the Forefront TMG object hierarchy.
For a detailed programmtic example of using the FPCEventDefinitions collection to create a new event for signaling an alert in a Web filter, see Signaling Events and Alerts. For information about using events to signal alerts in application filters, see Using Events and Alerts.
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 FPCEventDefinitions collection has these types of members:
- Methods
- Properties
Methods
The FPCEventDefinitions collection has these methods.
| Method | Description |
|---|---|
| Add | Creates a new FPCEventDefinition object in the collection and returns a reference to it. |
| Item | Retrieves the requested FPCEventDefinition object from the collection. |
| ItemByGuid | Retrieves the requested FPCEventDefinition object from the collection according to the globally unique identifier (GUID) of its event. |
| Remove | Removes the specified FPCEventDefinition object from the collection. |
Properties
The FPCEventDefinitions collection has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Gets an enumerator object for the collection. |
|
| Read-only | Gets the number of FPCEventDefinition 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 properties of the collection and its elements can be imported from the specified XML document. |
| Export | Writes the stored values of all the properties of the collection and its elements to the specified XML document. |
| ExportToFile | Writes the stored values of all the properties of the collection and its elements 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 the properties of the collection and its elements from the specified XML document to persistent storage. |
| ImportFromFile | Copies the values of all the properties of the collection and its elements 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 the properties of the collection and its elements from persistent storage, overwriting any changes that have not been saved. |
| Save | Writes the current values of all the properties of the collection and its elements 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 collection. 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 collection. |
Interfaces for C++ Programming
This collection implements the IFPCEventDefinitions 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
Build date: 7/12/2010