Partager via


SPWeb.GetChanges - Méthode (SPChangeQuery)

Obtient les modifications du journal des modifications filtré par la requête spécifiée.

Espace de noms :  Microsoft.SharePoint
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Function GetChanges ( _
    query As SPChangeQuery _
) As SPChangeCollection
'Utilisation
Dim instance As SPWeb
Dim query As SPChangeQuery
Dim returnValue As SPChangeCollection

returnValue = instance.GetChanges(query)
public SPChangeCollection GetChanges(
    SPChangeQuery query
)

Paramètres

Valeur renvoyée

Type : Microsoft.SharePoint.SPChangeCollection
Les modifications qui ont eu lieu sur le site Web en fonction de la requête spécifiée. Spécifier le nombre maximal de modifications pour retourner en définissant la propriété FetchLimit du paramètre de requête.

Remarques

Cette méthode permet d'obtenir des modifications à des objets particuliers, au lieu de tous les objets, ou uniquement pour les actions sélectionnées sur des objets particuliers. Pour plus d'informations, consultez la la classe SPChangeQuery .

Notes

Par défaut, le journal des modifications conserve les données pendant 60 jours. Pour modifier la période de rétention par défaut, définissez la propriété ChangeLogRetentionPeriod .

Exemples

L'exemple suivant est une application console qui crée un fichier texte contenant des informations sur les éléments de liste qui ont été ajoutés, supprimés ou mis à jour. L'application appelle la méthode GetChanges dans une boucle, l'extraction des modifications par lots jusqu'à ce que toutes les modifications ont été récupérées.

using System;
using System.IO;
using Microsoft.SharePoint;

namespace Test
{
   class ConsoleApp
   {
      static void Main(string[] args)
      {
         using (SPSite siteCollection = new SPSite("https://localhost"))
         {
            using (SPWeb webSite = siteCollection.RootWeb)
            {

               // Construct a query
               SPChangeQuery query = new SPChangeQuery(false,  // limit object types
                                                       false); // limit change types

               // object type 
               query.Item = true;

               // change types 
               query.Add = true;
               query.Delete = true;
               query.Update = true;

               SPTimeZone timeZone = webSite.RegionalSettings.TimeZone;
               long total = 0;

               string fileName = "ItemChanges.txt";
               StreamWriter writer = File.AppendText(fileName);

               while (true)
               {

                  SPChangeCollection changes = webSite.GetChanges(query);
                  total += changes.Count;

                  foreach (SPChangeItem change in changes)
                  {
                     // Get the list title
                     string listTitle = String.Empty;
                     string itemName = String.Empty;
                     SPList list = null;
                     try
                     {
                        list = webSite.Lists[change.ListId];
                        listTitle = list.Title;
                     }
                     catch (SPException)
                     {
                        listTitle = "Unknown";
                     }

                     // Get the item title
                     if (list != null)
                     {
                        SPListItem item = null;
                        try
                        {
                           item = list.GetItemByUniqueId(change.UniqueId);
                           itemName = item.Name;
                        }
                        catch (ArgumentException)
                        {
                           itemName = "Unknown";
                        }

                     }

                     // Write to the log
                     writer.WriteLine("\r\nDate: {0}",
                        timeZone.UTCToLocalTime(change.Time).ToString());
                     writer.WriteLine("Change: {0} item", change.ChangeType);
                     writer.WriteLine("List: {0}", listTitle);
                     writer.WriteLine("Item: {0}", itemName);

                  }

                  // Break out of loop if we have the last batch
                  if (changes.Count < query.FetchLimit)
                     break;
                  // Otherwise, go get another batch
                  query.ChangeTokenStart = changes.LastChangeToken;
               }

               writer.WriteLine("\r\nTotal changes = {0:#,#}", total);
               writer.Flush();
               writer.Close();

               Console.WriteLine("{0} changes written to {1}", total, fileName);
            }
         }
         Console.Write("\nPress ENTER to continue...");
         Console.ReadLine();
      }
   }
}
Imports System
Imports System.IO
Imports Microsoft.SharePoint

Module ConsoleApp
   Sub Main()
      Using siteCollection As SPSite = New SPSite("https://localhost")
         Using webSite As SPWeb = siteCollection.RootWeb

            ' Construct a query
            Dim query As New SPChangeQuery(False, False)

            ' object type
            query.Item = True

            ' change types 
            query.Add = True
            query.Delete = True
            query.Update = True

            Dim timeZone As SPTimeZone = webSite.RegionalSettings.TimeZone
            Dim total As Long = 0

            Dim fileName As String = "ItemChanges.txt"
            Dim writer As StreamWriter = File.AppendText(fileName)

            While True

               Dim changes As SPChangeCollection = webSite.GetChanges(query)
               total += changes.Count

               For Each change As SPChangeItem In changes
                  ' Get the list title
                  Dim listTitle As String = String.Empty
                  Dim itemName As String = String.Empty
                  Dim list As SPList = Nothing
                  Try
                     list = webSite.Lists(change.ListId)
                     listTitle = list.Title
                  Catch ex As SPException
                     listTitle = "Unknown"
                  End Try

                  ' Get the item title
                  If list IsNot Nothing Then
                     Dim item As SPListItem = Nothing
                     Try
                        item = list.GetItemByUniqueId(change.UniqueId) 
                        itemName = item.Name
                     Catch ex As ArgumentException
                        itemName = "Unknown"
                     End Try
                  End If

                  ' Write to the log
                  writer.WriteLine(vbCrLf + "Date: {0}", _
                                   timeZone.UTCToLocalTime(change.Time).ToString())
                  writer.WriteLine("Change: {0} item", change.ChangeType)
                  writer.WriteLine("List: {0}", listTitle)
                  writer.WriteLine("Item: {0}", itemName)
               Next change

               ' Break out of the loop when we fetch the last batch of changes
               If changes.Count < query.FetchLimit Then
                  Exit While
               End If

               ' Go get another batch of changes starting where we left off
               query.ChangeTokenStart = changes.LastChangeToken

            End While

            writer.WriteLine(vbCrLf + "Total changes = {0:#,#}", total)
            writer.Flush()
            writer.Close()

            Console.WriteLine("{0} changes written to {1}", total, fileName)

         End Using
      End Using

      Console.Write(vbCrLf + "Press ENTER to continue...")
      Console.ReadLine()

   End Sub
End Module

Voir aussi

Référence

SPWeb classe

SPWeb - Membres

GetChanges - Surcharge

Microsoft.SharePoint - Espace de noms

Autres ressources

Using the Change Log