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

AF SDK Reference

PISystem.ImportXml Method (Object, PIImportMode, Stream, EventHandler(AFProgressEventArgs))

PISystem.ImportXml Method (Object, PIImportMode, Stream, EventHandler(AFProgressEventArgs))

  • Last UpdatedNov 18, 2025
  • 2 minute read
PISystem.ImportXml Method (Object, PIImportMode, Stream, EventHandler(AFProgressEventArgs))
Imports the XML representation of any object from a stream.

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

Syntax

public int ImportXml(
	Object importObject,
	PIImportMode importMode,
	Stream xmlStream,
	EventHandler<AFProgressEventArgs> eventHandler
)
Public Function ImportXml ( 
	importObject As Object,
	importMode As PIImportMode,
	xmlStream As Stream,
	eventHandler As EventHandler(Of AFProgressEventArgs)
) As Integer

Dim instance As PISystem
Dim importObject As Object
Dim importMode As PIImportMode
Dim xmlStream As Stream
Dim eventHandler As EventHandler(Of AFProgressEventArgs)
Dim returnValue As Integer

returnValue = instance.ImportXml(importObject, 
	importMode, xmlStream, eventHandler)
public:
int ImportXml(
	Object^ importObject, 
	PIImportMode importMode, 
	Stream^ xmlStream, 
	EventHandler<AFProgressEventArgs^>^ eventHandler
)
member ImportXml : 
        importObject : Object * 
        importMode : PIImportMode * 
        xmlStream : Stream * 
        eventHandler : EventHandler<AFProgressEventArgs> -> int 

Parameters

importObject
Type: SystemObject
The object to import the XML data into. If , the PISystem object will be used.
importMode
Type: OSIsoft.AFPIImportMode
One or more of the PIImportMode values which indicates how to import.
xmlStream
Type: System.IOStream
The XML stream to import.
eventHandler
Type: SystemEventHandlerAFProgressEventArgs
Delegate used to receive progress indication on operations.

Return Value

Type: Int32
Returns the number of items updated or created.

Remarks

The XML representation of the objects are imported into the specified import object.

Version Information

AFSDK


See Also

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