FPCEventDefinition object

Applies to: desktop apps only

The FPCEventDefinition object is used to define a single event. Events describe conditions that require the attention of an administrator. Predetermined actions can be triggered in response to particular events by using the FPCAlert object. Each event is uniquely identified by its EventGUID property.

This object is an element of an FPCEventDefinitions collection.

Click here to see the Forefront TMG object hierarchy.

For a detailed programmtic example of using the FPCEventDefinition object to create a new event for signaling alerts 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 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 an object's data to and importing it from an XML document.

Members

The FPCEventDefinition object has these types of members:

• Methods
• Properties

Methods

The FPCEventDefinition object has these methods.

Method	Description
Signal	Signals the event on the local server.

 

Properties

The FPCEventDefinition object has these properties.

Property	Access type	Description
AdditionalKeys	Read-only	Gets the table of additional keys and subevents defined for the event.
AdditionalKeysCount	Read-only	Gets the number of additional keys for the event.
Description	Read/write	Gets or sets the description of the event.
EventGUID	Read-only	Gets the globally unique identifier (GUID) of the event.
EventsBeforeRaise	Read/write	Gets or sets the default number of times that the event must be signaled before an alert that is issued for the event can be issued.
MinEventsPerSecond	Read/write	Gets or sets the default number of times in a second that the event must be signaled before an alert that is issued for the event can be issued.
MinutesBeforeReRaise	Read/write	Gets or sets the default time, in minutes, that must elapse before an alert that is issued for the event can be issued again.
Name	Read/write	Gets or sets the name of the event.
Predefined	Read-only	Gets a Boolean value that indicates whether the event is a predefined event that was installed with Forefront TMG and cannot be deleted.

 

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 object implements the IFPCEventDefinition 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