SPHealthAnalyzer.RegisterRules method

Registers all the rules in an assembly with the SharePoint Health Analyzer rules list for the local farm.

Namespace:  Microsoft.SharePoint.Administration.Health
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)


Public Shared Function RegisterRules ( _
    assembly As Assembly _
) As IDictionary(Of Type, Exception)
Dim assembly As [Assembly]
Dim returnValue As IDictionary(Of Type, Exception)

returnValue = SPHealthAnalyzer.RegisterRules(assembly)
public static IDictionary<Type, Exception> RegisterRules(
    Assembly assembly


Return value

Type: System.Collections.Generic.IDictionary<Type, Exception>
A list of types that could not be registered and the exceptions that were thrown when registration failed.


The following example shows how to call the RegisterRules method in the FeatureActivated method of a class derived from the SPFeatureReceiver class. The example assumes that the feature receiver is in the same assembly as the rules that are being registered.

public override void FeatureActivated(SPFeatureReceiverProperties properties)
    Assembly a = Assembly.GetExecutingAssembly();
    IDictionary<Type, Exception> exceptions = SPHealthAnalyzer.RegisterRules(a);

    if (exceptions != null)
        string logEntry = a.FullName;
        if (exceptions.Count == 0)
            logEntry += " All rules were registered.";
            foreach (KeyValuePair<Type, Exception> pair in exceptions)
                logEntry += string.Format(" Registration failed for type {0}. {1}",
                                          pair.Key, pair.Value.Message);
Public Overrides Sub FeatureActivated(ByVal properties As Microsoft.SharePoint.SPFeatureReceiverProperties)

    Dim a As Assembly = Assembly.GetExecutingAssembly()
    Dim exceptions As IDictionary(Of Type, Exception) = SPHealthAnalyzer.RegisterRules(a)

    If Not exceptions Is Nothing Then
        Dim logEntry As String = a.FullName
        If exceptions.Count = 0 Then
            logEntry += " All rules were registered."
            Dim pair As KeyValuePair(Of Type, Exception)
            For Each pair In exceptions
                logEntry += String.Format(" Registration failed for type {0}. {1}", _
                                              pair.Key, pair.Value.Message)
        End If
    End If

End Sub

See also


SPHealthAnalyzer class

SPHealthAnalyzer members

Microsoft.SharePoint.Administration.Health namespace


Other resources

How to: Install a Health Rule