modifyServerList Method

See Also       Example        Applies To       Specifics

 

This method can be used to add servers to the list or remove them from the list, one at a time. The specified server is added or removed without any adverse effect on the existing servers. The intend is to allow the host to modify the servers list without a full "reset".

This method returns a success code (int), 0 = success.

 

Syntax

[Visual Basic]

Public Function object.modifyServerList( ByVal serverName As String, addServer As Boolean ) As Integer

[C#]

public int object.modifyServerList( string serverName, bool addServer );

 

The modifyServerList method syntax has these parts:

 

Part

Description

object

An object expression that evaluates to a PIAcrhiveEditor object.

serverName

A know/defined server name.

addServer

Defines if the server should be added (true) or removed (false).

 

Remarks

The caller must pass a valid server name or the method will fail. The method will fail when trying to remove a non-existing server or trying add an unknown server (not in known server list) or trying to add the server twice.

 

Requirements

    Assembly: OSIsoft.PISDK.Controls.PIAcrhiveEditor (in OSIsoft.PISDK.Controls.PIAcrhiveEditor .dll)

 

 


Enabling Operational Intelligence