SPHealthRulesList-Klasse

Artikel
05/06/2015

Stellt eine Liste der SharePoint-Integritätsanalyse Regeldefinitionen mit der Farm registriert.

Vererbungshierarchie

System.Object
  Microsoft.SharePoint.SPSecurableObject
    Microsoft.SharePoint.SPList
      Microsoft.SharePoint.Administration.Health.SPHealthRulesList

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

Syntax

'Declaration
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
Public NotInheritable Class SPHealthRulesList _
    Inherits SPList _
    Implements IDisposable
'Usage
Dim instance As SPHealthRulesList

[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
public sealed class SPHealthRulesList : SPList, 
    IDisposable

Hinweise

Diese Klasse stellt die Liste Integritätsregeln im Abschnitt Überwachung der Zentraladministration. Ein Farmadministrator können die Liste Integritätsregeln bearbeiten die Einstellungen für eine Integritätsregel, ändern, wo oder wann die Regel ausgeführt wird, oder sogar die Regel vollständig deaktivieren.

Wenn Sie eine Instanz der Klasse SPHealthRulesList erhalten möchten, Zugriff auf die statische Local -Eigenschaft. Sobald Sie SPHealthRulesList -Objekt haben, können Sie die Liste Abfragen, wie ein beliebiges SPList -Objekt.

Wichtig

Das von der Local -Eigenschaft zurückgegebene SPHealthRulesList -Objekt verwendet wird, nicht verwaltete Ressourcen. Sie sind verantwortlich für die Freigabe dieser Ressourcen. Eine Möglichkeit, dies ist die Dispose() -Methode aufrufen, wenn das Objekt nicht mehr benötigen.

Beispiele

Das folgende Beispiel ist eine Konsolenanwendung, die den Titel und den Zeitplan für jede Regel in der Liste Integritätsregeln für die Farm wird gedruckt. Beachten Sie, um der Liste Integritätsregeln zugreifen, muss der lokale Server der Farm hinzugefügt.

using System;
using Microsoft.SharePoint;
using Microsoft.SharePoint.Administration;
using Microsoft.SharePoint.Administration.Health;

namespace Test
{
    class Program
    {
        static void Main(string[] args)
        {
            if (SPFarm.Joined)
            {
                using (SPHealthRulesList list = SPHealthRulesList.Local)
                {
                    // Get a collection of rule definitions in alphabetical order.
                    SPQuery query = new SPQuery();
                    query.Query = "<OrderBy><FieldRef Name=\"LinkTitleNoMenu\" /></OrderBy>";
                    SPListItemCollection rules = list.GetItems(query);

                    // Print the title and schedule for each item.
                    foreach (SPListItem rule in rules)
                    {
                        Console.WriteLine("\n{0} Runs: {1}",
                            rule[SPBuiltInFieldId.LinkTitleNoMenu].ToString(),
                            rule[SPBuiltInFieldId.HealthRuleSchedule].ToString());
                    }
                }
            }
            Console.Write("\nPress ENTER to continue...");
            Console.Read();
        }
    }
}

Imports System
Imports Microsoft.SharePoint
Imports Microsoft.SharePoint.Administration
Imports Microsoft.SharePoint.Administration.Health

Module Test

    Sub Main()

        If SPFarm.Joined Then

            Using list As SPHealthRulesList = SPHealthRulesList.Local

                ' Get a collection of rule definitions in alphabetical order.
                Dim query As SPQuery = New SPQuery()
                query.Query = "<OrderBy><FieldRef Name='LinkTitleNoMenu' /></OrderBy>"
                Dim rules As SPListItemCollection = list.GetItems(query)

                ' Print the title, date, and status for each item.
                Dim rule As SPListItem
                For Each rule In rules
                    Console.WriteLine(vbCrLf + "{0} Runs: {1}", _
                            rule(SPBuiltInFieldId.LinkTitleNoMenu).ToString(), _
                            rule(SPBuiltInFieldId.HealthRuleSchedule).ToString())
                Next

            End Using
        End If
        Console.Write(vbCrLf + "Press ENTER to continue...")
        Console.Read()
    End Sub

End Module

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic) Member dieses Typs sind threadsicher. Die Threadsicherheit von Instanzmembern ist nicht gewährleistet.