Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFDataReference.ReplacePIServer Method (AFDatabase, String, String, EventHandler(AFProgressEventArgs))

AFDataReference.ReplacePIServer Method (AFDatabase, String, String, EventHandler(AFProgressEventArgs))

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFDataReference.ReplacePIServer Method (AFDatabase, String, String, EventHandler(AFProgressEventArgs))
Replaces the PI Data Archive server name with another server on the PI Point and PI Point Array data references found within the attributes and attribute templates and its children of a database.

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

Syntax

public static int ReplacePIServer(
	AFDatabase database,
	string oldServerName,
	string newServerName,
	EventHandler<AFProgressEventArgs> eventHandler
)
Public Shared Function ReplacePIServer ( 
	database As AFDatabase,
	oldServerName As String,
	newServerName As String,
	eventHandler As EventHandler(Of AFProgressEventArgs)
) As Integer

Dim database As AFDatabase
Dim oldServerName As String
Dim newServerName As String
Dim eventHandler As EventHandler(Of AFProgressEventArgs)
Dim returnValue As Integer

returnValue = AFDataReference.ReplacePIServer(database, 
	oldServerName, newServerName, eventHandler)
public:
static int ReplacePIServer(
	AFDatabase^ database, 
	String^ oldServerName, 
	String^ newServerName, 
	EventHandler<AFProgressEventArgs^>^ eventHandler
)
static member ReplacePIServer : 
        database : AFDatabase * 
        oldServerName : string * 
        newServerName : string * 
        eventHandler : EventHandler<AFProgressEventArgs> -> int 

Parameters

database
Type: OSIsoft.AFAFDatabase
The database containing the attributes.
oldServerName
Type: SystemString
The PI Data Archive server name that needs to be changed.
newServerName
Type: SystemString
The PI Data Archive server name to change to.
eventHandler
Type: SystemEventHandlerAFProgressEventArgs
Delegate used to receive progress indication on operations.

Return Value

Type: Int32
Returns the number of data reference configurations that were modified.

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, 2.8.5, 2.8, 2.7.5, 2.7, 2.6

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in