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

AF SDK Reference

PISystem.UploadPlugInAssembly Method

  • Last UpdatedNov 18, 2025
  • 2 minute read
PISystem.UploadPlugInAssembly Method
Uploads a AFPlugIn assembly to the database.

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

Syntax

public int UploadPlugInAssembly(
	string filePath,
	bool force
)
Public Function UploadPlugInAssembly ( 
	filePath As String,
	force As Boolean
) As Integer

Dim instance As PISystem
Dim filePath As String
Dim force As Boolean
Dim returnValue As Integer

returnValue = instance.UploadPlugInAssembly(filePath, 
	force)
public:
int UploadPlugInAssembly(
	String^ filePath, 
	bool force
)
member UploadPlugInAssembly : 
        filePath : string * 
        force : bool -> int 

Parameters

filePath
Type: SystemString
The filePath of the local assembly to be uploaded.
force
Type: SystemBoolean
Set to if assembly should be uploaded even if it is older than existing assembly.

Return Value

Type: Int32
The number of plugins registered in the assembly.

Remarks

Use this routine to upload an assembly to the server which defines one or more AFPlugIns. Once uploaded, the plugins will become available to all client applications. Note that once an assembly has been loaded into a client application, it cannot be updated until that application is restarted.

Use the UploadPlugInSupportAssembly(Guid, String, String, Boolean) to upload support assemblies for the plugin. An example would be language resource DLLs.

Version Information

AFSDK


See Also

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