Compartilhar via


SPChangeTokenCollection.ToString method

Obtém a representação de cadeia de caracteres serializada da coleção token de alteração.

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

Syntax

'Declaração
Public Overrides Function ToString As String
'Uso
Dim instance As SPChangeTokenCollection
Dim returnValue As String

returnValue = instance.ToString()
public override string ToString()

Valor retornado

Type: System.String
Uma seqüência de caracteres que contém a representação de cadeia de caracteres serializada da coleção.

Comentários

Você pode usar esse método para serializar uma coleção do token de alteração antes persisti-los em um armazenamento permanente. Para reconstruir a coleção, passe a representação de cadeia de caracteres serializada da coleção para a sobrecarga do construtor SPChangeTokenCollection que aceita uma cadeia de caracteres.

Examples

O exemplo a seguir consiste em duas rotinas de um aplicativo maior. A primeira é um procedimento que grava uma coleção do token de alteração em um arquivo no disco. O segundo é uma função que aceita um nome de arquivo como argumento, abre o arquivo, lê a primeira variável de cadeia de caracteres serializada, ele localiza e usa isso para criar uma coleção de token de alteração, valor de retorno da função. Observe que, se o arquivo não foi encontrado ou não conter uma variável de cadeia de caracteres formatada corretamente, a função retornará uma coleção vazia.

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;
}

Ver também

Referência

SPChangeTokenCollection class

SPChangeTokenCollection members

Microsoft.SharePoint namespace

ToString()