XDASrv Reference Manual
GetServerInstanceInfo Method
See Also  Send Feedback
NSPlugin Namespace > GenericServer Class : GetServerInstanceInfo Method




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.
Generic server callback method. Supported only by the Professional Edition generic server V5.1 or newer.
Get information about all server instances or the requested server instance only. This information may be used to identify the client application, especially when the client application defines a name using the SetClientName OPC method.
Be aware the 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.

Syntax

Visual Basic (Declaration) 
Public Shared Function GetServerInstanceInfo( _
   ByVal handle As Integer, _
   ByRef info As ServerInstanceInfo() _
) As Integer
Visual Basic (Usage)Copy Code
Dim handle As Integer
Dim info As ServerInstanceInfo()
Dim value As Integer
 
value = GenericServer.GetServerInstanceInfo(handle, info)
C# 
public static int GetServerInstanceInfo( 
   int handle,
   out ServerInstanceInfo[] info
)
Managed Extensions for C++ 
public: static int GetServerInstanceInfo( 
   int handle,
   [PARAMFLAG::Out] ServerInstanceInfo*[] info
)
C++/CLI 
public:
static int GetServerInstanceInfo( 
   int handle,
   [Out] array<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 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

Copyright © 2002-2011 Advosol Inc. All Rights Reserved.