AF SDK Reference

PISystem.GetFindChangedItemsCookie Method

Save PDF

TABLE OF CONTENTS

PISystem.GetFindChangedItemsCookie Method

Save PDF

Last UpdatedNov 18, 2025
6 minute read

Retrieve the server cookie used in conjunction with FindChangedItems.

Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public Object GetFindChangedItemsCookie(
	bool searchSandbox
)

Public Function GetFindChangedItemsCookie ( 
	searchSandbox As Boolean
) As Object

Dim instance As PISystem
Dim searchSandbox As Boolean
Dim returnValue As Object

returnValue = instance.GetFindChangedItemsCookie(searchSandbox)

public:
Object^ GetFindChangedItemsCookie(
	bool searchSandbox
)

member GetFindChangedItemsCookie : 
        searchSandbox : bool -> Object

Parameters

searchSandbox: Type: SystemBoolean
Set to if the returned cookie will be used for searching for changes in the sandbox.

Return Value

Type: Object
Returns an object to pass as the cookie parameter to one of the PISystemFindChangedItems methods to find all changes after this method call.

Remarks

This method will be used to retrieve an object representing a server cookie that will be used in conjunction with PISystemFindChangedItems. The returned object can be used as the cookie parameter to one of the PISystemFindChangedItems methods to find all changes after this method call.

Notes to Callers
This call might use a background task to complete some of its work. See the Threading Overview for some matters to consider when execution transitions to another thread.

Examples

// This example demonstrates getting changes made by other users
//  and refreshing the objects.

// Get the System and System Cookie
PISystem myPISystem = new PISystems().DefaultPISystem;
object sysCookie = myPISystem.GetFindChangedItemsCookie(searchSandbox: false);

// Wait for changes to be made...
//=======================================================

// Find changes made by other users.
List<AFChangeInfo> list = new List<AFChangeInfo>();
int resultsPerPage = 1000;
while (true)
{
    var results = myPISystem.FindChangedItems(false, true, resultsPerPage, sysCookie, out sysCookie);
    if ((results?.Count ?? 0) == 0) break;
    list.AddRange(results);
}

// Refresh objects that have been changed.
AFChangeInfo.Refresh(myPISystem, list);

// Find the objects that have been changed.
foreach (AFChangeInfo info in list)
{
    AFObject myObj = info.FindObject(myPISystem, false);
    Console.WriteLine("Found changed object: {0}", myObj);
}

' This example demonstrates getting changes made by other users
'  and refreshing the objects.

' Get the System and System Cookie
Dim myPISystem As PISystem = New PISystems().DefaultPISystem
Dim sysCookie As Object = myPISystem.GetFindChangedItemsCookie(searchSandbox:=False)

' Wait for changes to be made...
'=======================================================


' Find changes made by other users.
Dim list As New List(Of AFChangeInfo)()
Dim resultsPerPage As Integer = 1000
While True
    Dim results As IList(Of AFChangeInfo) _
        = myPISystem.FindChangedItems(False, True, resultsPerPage, sysCookie, sysCookie)
    If ((results Is Nothing) OrElse (results.Count = 0)) Then
        Exit While
    End If

    list.AddRange(results)
End While

' Refresh objects that have been changed.
AFChangeInfo.Refresh(myPISystem, list)

' Find the objects that have been changed.
For Each info As AFChangeInfo In list
    Dim myObj As AFObject = info.FindObject(myPISystem, False)
    Console.WriteLine("Found changed object: {0}", myObj)
Next

No code example is currently available or this language may not be supported.

// This example demonstrates persisting and restoring the cookie
//  using the XmlSerializer. Other serializers could also be used.
//  Then the cookie is restored and used to get changes made while
//  the application was shut down.

// Get the System and Database and their Cookie Values
PISystem myPISystem = new PISystems().DefaultPISystem;
AFDatabase myDB = myPISystem.Databases.DefaultDatabase;

object sysCookie = myPISystem.GetFindChangedItemsCookie(searchSandbox: false);
object dbCookie;
myDB.FindChangedItems(false, int.MaxValue, null, out dbCookie);

// Persist the cookie if you want to save to pick up changes
//  where you left off after restarting application.
string tmpDir = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData);
string sysCookieFile = Path.Combine(tmpDir, "AFSysCookie.xml");
string dbCookieFile = Path.Combine(tmpDir, "AFDbCookie.xml");
XmlSerializer serializer = new XmlSerializer(typeof(object[]));
using (var stream = File.Create(sysCookieFile))
{
    serializer.Serialize(stream, sysCookie);
}
using (var stream = File.Create(dbCookieFile))
{
    serializer.Serialize(stream, dbCookie);
}

// Shut down application, and wait for changes to be made...
//=======================================================

// After application restarts, reload persisted cookies.
using (var stream = File.OpenRead(sysCookieFile))
{
    sysCookie = serializer.Deserialize(stream);
}
using (var stream = File.OpenRead(dbCookieFile))
{
    dbCookie = serializer.Deserialize(stream);
}

// Find changes made while application not running.
List<AFChangeInfo> list = new List<AFChangeInfo>();
int resultsPerPage = 1000;
while (true)
{
    var results = myPISystem.FindChangedItems(false, resultsPerPage, sysCookie, out sysCookie);
    if ((results?.Count ?? 0) == 0) break;
    list.AddRange(results);
}
while (true)
{
    var results = myDB.FindChangedItems(false, resultsPerPage, dbCookie, out dbCookie);
    if ((results?.Count ?? 0) == 0) break;
    list.AddRange(results);
}

// Find the objects that have been changed.
foreach (AFChangeInfo info in list)
{
    AFObject myObj = info.FindObject(myPISystem, false);
    Console.WriteLine("Found changed object: {0}", myObj);
}

' This example demonstrates persisting and restoring the cookie
'  using the XmlSerializer. Other serializers could also be used.
'  Then the cookie is restored and used to get changes made while
'  the application was shut down.

' Get the System and Database and their Cookie Values
Dim myPISystem As PISystem = New PISystems().DefaultPISystem
Dim myDB As AFDatabase = myPISystem.Databases.DefaultDatabase

Dim sysCookie As Object = myPISystem.GetFindChangedItemsCookie(searchSandbox:=False)
Dim dbCookie As Object = Nothing
myDB.FindChangedItems(False, Integer.MaxValue, Nothing, dbCookie)

' Persist the cookie if you want to save to pick up changes
'  where you left off after restarting application.
Dim tmpDir As String = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData)
Dim sysCookieFile As String = Path.Combine(tmpDir, "AFSysCookie.xml")
Dim dbCookieFile As String = Path.Combine(tmpDir, "AFDbCookie.xml")
Dim serializer As XmlSerializer = New XmlSerializer(GetType(Object()))
Using stream As FileStream = File.Create(sysCookieFile)
    serializer.Serialize(stream, sysCookie)
End Using
Using stream As FileStream = File.Create(dbCookieFile)
    serializer.Serialize(stream, dbCookie)
End Using

' Shut down application, and wait for changes to be made...
'=======================================================


' After application restarts, reload persisted cookies.
Using stream As FileStream = File.OpenRead(sysCookieFile)
    sysCookie = serializer.Deserialize(stream)
End Using
Using stream As FileStream = File.OpenRead(dbCookieFile)
    dbCookie = serializer.Deserialize(stream)
End Using

' Find changes made while application not running.
Dim list As List(Of AFChangeInfo) = New List(Of AFChangeInfo)
Dim resultsPerPage As Integer = 1000
While True
    Dim results As IList(Of AFChangeInfo) _
        = myPISystem.FindChangedItems(False, resultsPerPage, sysCookie, sysCookie)
    If ((results Is Nothing) OrElse (results.Count = 0)) Then
        Exit While
    End If

    list.AddRange(results)
End While
While True
    Dim results As IList(Of AFChangeInfo) _
        = myDB.FindChangedItems(False, resultsPerPage, dbCookie, dbCookie)
    If ((results Is Nothing) OrElse (results.Count = 0)) Then
        Exit While
    End If

    list.AddRange(results)
End While

list.AddRange(myPISystem.FindChangedItems(False, Integer.MaxValue, sysCookie, sysCookie))
list.AddRange(myDB.FindChangedItems(False, Integer.MaxValue, dbCookie, dbCookie))

' Find the objects that have been changed.
For Each info As AFChangeInfo In list
    Dim myObj As AFObject = info.FindObject(myPISystem, False)
    Console.WriteLine("Found changed object: {0}", myObj)
Next

No code example is currently available or this language may not be supported.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9

AF SDK Reference