Freigeben über


SPChangeTokenCollection.ToString-Methode

Ruft die serialisierten Zeichenfolgendarstellung der token-Auflistung ändern.

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

Syntax

'Declaration
Public Overrides Function ToString As String
'Usage
Dim instance As SPChangeTokenCollection
Dim returnValue As String

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

Rückgabewert

Typ: System.String
Eine Zeichenfolge, die die serialisierte Darstellung der Auflistung enthält.

Hinweise

Verwenden Sie diese Methode zum Serialisieren der token-Auflistung eine Änderung vor dauerhaft zu speichern. Um die Sammlung zu rekonstruieren, übergeben Sie die serialisierte Zeichenfolge-Darstellung der Auflistung an die Überladung SPChangeTokenCollection -Konstruktor, der eine Zeichenfolge akzeptiert.

Beispiele

Das folgende Beispiel besteht aus zwei Routinen in einer umfangreicheren Anwendung. Die erste ist eine Prozedur, die eine Änderung token-Auflistung in eine Datei auf dem Datenträger schreibt. Die zweite ist eine Funktion, die einen Dateinamen als Argument akzeptiert, wird die Datei geöffnet, liest die erste serialisierte Zeichenfolge-Variable, und verwendet, die zum Erstellen einer Änderung token Auflistung Rückgabewert der Funktion. Beachten Sie, dass, wenn die Datei nicht gefunden wurde oder eine korrekt formatierte Zeichenfolgenvariable enthält, die Funktion eine leere Auflistung gibt.

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

Siehe auch

Referenz

SPChangeTokenCollection Klasse

SPChangeTokenCollection-Member

Microsoft.SharePoint-Namespace

ToString()