Get information about all DA server instances / UA server sessions or the requested server instance/session only. This information may be used to identify the client application, especially when the client application. DA client may have to define a name using the SetClientName OPC method.
Be aware that for DA clients the client name cannot yet be defined during the instance creation (ServerInstancesChange call for creation). The client application has to call SetClientName() to define the name.
The client handle is passed as an argument to the plugin methods ValidateItems and WriteItems to enable the server to allow/deny the access based on the instance information. The NSPlugin code can use the handle to retrieve ServerInstanceInfo and possibly reject a request based on the client credentials.
Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Shared Function GetServerInstanceInfo( _ ByVal handle As Integer, _ ByRef info As ServerInstanceInfo() _ ) As Integer | |
| C# | |
|---|---|
public static int GetServerInstanceInfo( int handle, out ServerInstanceInfo[] info ) | |
Parameters
- handle
- Handle of the server instance or 0 for all instances
- info
- Current server instance data. The array lenght is 0 if the requested instance doesn't exist.
Requirements
Target Platforms: Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows 7, Windows Server 2008 family