GetServerStatus method
Returns the status of the specified server. The FullServerName parameter must include the complete path to the server; for example,
Application
.GetServerStatus
/Building/Line4/Mixer:MixingServer.If the server in the example is at the root of the application, the syntax is
Application
.GetServerStatus
/:MixingServer.Syntax
Application
.GetServerStatus
FullServerName, PrimaryStatus, SecondaryStatus, ActiveComputerName
where
Application
– is the name of a FactoryTalk View SE
Client Application object or an expression that evaluates to a FactoryTalk View SE
Client Application object.FullServerName
– is a string that specifies the name of the server, including its path. If the specified server does not exist an error will be raised. For the FactoryTalk Directory server, the FullServerName parameter should be specified as FTDirectory.PrimaryStatus
– is a variable of the type Long that will be set to the status of the primary server instance. The value returned will be one of the gfxServerStatusConstants.SecondaryState
– is a variable of the type Long that will be set to the state of the secondary server. The value returned will be one of the gfxServerStateConstants. If a secondary server has not been set up, the value returned will be gfxServerStatusSecondaryNotDefined.ActiveComputerName
– is a variable of the type String that will be set to the name of the computer hosting the active server instance.Remarks
- If a redundant (standby) server is defined, the computer name that is returned is the name of the computer hosting the active server instance. When the primary server is active, the primary server computer name is returned. When the secondary server is active, the secondary server computer name is returned.
- When you use the GetServerStatus method with an Area name provided by the ServiceDisruption event or ServiceRecovery event, the Application Name must be removed from the Area parameter before the GetServerStatus method can use it as part of the FullServerName parameter. If you do not do this an error is raised.For example, for an application named App1, with an area named Area1 and a server named HMIServer1, the FullServerName string would beApp1/Area1:HMIServer1. The GetServerStatus expects the FullServerName to be/Area1:HMIServer1.
Provide Feedback