Update

The Update method updates the specified server in the server list.

Syntax

[Result=] aaServers.Update(aaServer server);

Parameters

server

The name of the server to update.

Return Value

Returns True if the given aaServer instance is currently in the server list; otherwise, False is returned.

Remarks

The Update method serves two purposes:

• It causes the list of servers (which is the list that appears in the Server Configuration dialog box) to be persisted, if persistence is in effect. For example, the AVEVA Historian Client Trend and the AVEVA Historian Client Query applications run with persistence in effect; when you start these applications, you see previously-configured servers in the list. Controls, however, do not necessarily run with persistence in effect. When changes are made to properties in an instance of the aaServer object, they are not persisted until the Update method is called.

• It causes an OnServerUpdated event to fire. This allows other parts of the application to respond to changes in any of the servers in the servers list. When changes are made to properties in an instance of aaServer, no event is fired to report the change until the Update method is called.

The aaServer instance must be the exact same instance, not an instance with the same name. If the instance is not in the list, then the list is not updated.

The aaServer instance passed as an argument to the OnServerUpdated event is the exact same instance that is in the list.