Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

RuleFiringRecord Class

Represents the firing record for an event that derives from the WebManagementEvent class and implements the IWebEventCustomEvaluator interface.

System.Object
  System.Web.Management.RuleFiringRecord

Namespace:  System.Web.Management
Assembly:  System.Web (in System.Web.dll)
public sealed class RuleFiringRecord

The RuleFiringRecord type exposes the following members.

  NameDescription
Public propertyLastFiredGets the last time that the event was last fired.
Public propertyTimesRaisedGets the total number of times that the event has been raised.
Top
  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The RuleFiringRecord class provides information that could be used to determine whether the firing of the event should be recorded.

The following code example shows how the RuleFiringRecord is used when passed to the CanFire method.

// Implements the IWebEventCustomEvaluator.CanFire  
// method. It is called by the ASP.NET if this custom 
// type is configured in the profile 
// element of the healthMonitoring section. 
public bool CanFire(
    System.Web.Management.WebBaseEvent e, 
    RuleFiringRecord rule)
{

    bool fireEvent;
    string lastFired = rule.LastFired.ToString();
    string timesRaised = rule.TimesRaised.ToString();

    // Fire every other event raised.
    fireEvent =
        (rule.TimesRaised % 2 == 0) ? true : false;

    if (fireEvent)
    {
        firingRecordInfo =
            string.Format("Event last fired: {0}",
            lastFired) +
            string.Format(". Times raised: {0}",
            timesRaised);
    }
    else
        firingRecordInfo =
          string.Format(
           "Event not fired. Times raised: {0}",
           timesRaised);

    return fireEvent;

}

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.