Метод SPChangeTokenCollection.ToString

Статья
05/13/2015

Возвращает сериализованное строковое представление коллекции маркеров изменения.

Пространство имен: Microsoft.SharePoint
Сборка: Microsoft.SharePoint (в Microsoft.SharePoint.dll)

Синтаксис

'Декларация
Public Overrides Function ToString As String
'Применение
Dim instance As SPChangeTokenCollection
Dim returnValue As String

returnValue = instance.ToString()

public override string ToString()

Возвращаемое значение

Тип: System.String
Строка, содержащая сериализованное строковое представление коллекции.

Замечания

Этот метод можно использовать для сериализации маркера изменения коллекции до ее сохранения в постоянное хранилище. Для реконструкции коллекции, передайте сериализованное строковое представление коллекции перегрузку конструктора SPChangeTokenCollection , который принимает строку.

Примеры

Следующий пример состоит из двух процедур из более крупных приложений. Первый является процедурой, которая записывает набор маркеров изменения в файл на диске. Второй является функцией, которая принимает в качестве аргумента имя файла, открывает файл, считывает первой переменной сериализованной строки оно находит и использует его для создания маркера изменения коллекции, возвращаемое значение функции. Обратите внимание, что если файл не найден или не содержит правильно отформатированный строковой переменной, функция возвращает пустую коллекцию.

Sub SaveTokens(ByRef tokens As SPChangeTokenCollection, ByVal filePath As String)
  Using fs As FileStream = File.Create(filePath)
     ' Serialize the tokens
     Dim bw As BinaryWriter = New BinaryWriter(fs)
     Dim s As String = tokens.ToString()
     bw.Write(s)

     ' flush and close
     bw.Flush()
     bw.Close()
  End Using
End Sub

Function GetTokens(ByVal filePath As String) As SPChangeTokenCollection

  Dim tokens As SPChangeTokenCollection = New SPChangeTokenCollection()

  ' If we have a persisted collection, use it
  If File.Exists(filePath) Then
     Using fs As FileStream = File.OpenRead(filePath)
        Dim br As BinaryReader = New BinaryReader(fs)
        Try
           Dim s As String = br.ReadString()
           ' Construct a change token from string
           tokens = New SPChangeTokenCollection(s)
        Catch 
           ' No serialized string, or an incorrectly formatted string.
           ' Do nothing. We'll return an empty collection.
        Finally
           br.Close()
        End Try
     End Using
  End If
  Return tokens
End Function

static void SaveTokens(SPChangeTokenCollection tokens, string filePath)
{
   using (FileStream fs = File.Create(filePath))
   {
      // Serialize the tokens
      BinaryWriter bw = new BinaryWriter(fs);
      string s = tokens.ToString();
      bw.Write(s);

      // flush and close
      bw.Flush();
      bw.Close();
   }
}

static SPChangeTokenCollection GetTokens(string filePath)
{
   SPChangeTokenCollection tokens = new SPChangeTokenCollection();

   // If we have a persisted collection, use it
   if (File.Exists(filePath))
   {
      using (FileStream fs = File.OpenRead(filePath))
      {
         BinaryReader br = new BinaryReader(fs);
         try
         {
            string s = br.ReadString();
            // Construct a change token from string
            tokens = new SPChangeTokenCollection(s);
         }
         catch 
         {
            // No serialized string, or an incorrectly formatted string.
            // Do nothing. We'll return an empty collection.
         }
         finally
         {
            br.Close();
         }
      }
   }

   return tokens;
}

См. также

Справочные материалы

SPChangeTokenCollection класс

Элементы SPChangeTokenCollection

Пространство имен Microsoft.SharePoint

ToString()

Поделиться через