QuickOPC User's Guide and Reference
BrowseServers Method (IEasyAEClient)
Example 



OpcLabs.EasyOpcClassic Assembly > OpcLabs.EasyOpc.AlarmsAndEvents Namespace > IEasyAEClient Interface : BrowseServers Method
Name of the machine. Determines the computer to browse for OPC servers. May be an empty string, in which case the local computer will be browsed.
The OPC technologies to be used for server browsing.
Browses the specified computer and returns information about OPC (Alarms and Events) servers found.
Syntax
'Declaration
 
<ElementsNotNullAttribute()>
<NotNullAttribute()>
Function BrowseServers( _
   ByVal location As String, _
   ByVal technologies As OpcTechnologies _
) As ServerElementCollection
'Usage
 
Dim instance As IEasyAEClient
Dim location As String
Dim technologies As OpcTechnologies
Dim value As ServerElementCollection
 
value = instance.BrowseServers(location, technologies)
[ElementsNotNull()]
[NotNull()]
ServerElementCollection BrowseServers( 
   string location,
   OpcTechnologies technologies
)
[ElementsNotNull()]
[NotNull()]
ServerElementCollection^ BrowseServers( 
   String^ location,
   OpcTechnologies technologies
) 

Parameters

location
Name of the machine. Determines the computer to browse for OPC servers. May be an empty string, in which case the local computer will be browsed.
technologies
The OPC technologies to be used for server browsing.

Return Value

The method returns a keyed collection of OpcLabs.EasyOpc.ServerElement values, each containing information about a particular OPC server found on the specified machine. The keys of the keyed collection are the server's CLSIDs.
Exceptions
ExceptionDescription
Thrown when the OPC operation fails.
A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.
Example
// This example shows how to obtain all ProgIDs of all OPC Alarms and Events servers on the local machine.

using System;
using System.Diagnostics;
using OpcLabs.EasyOpc;
using OpcLabs.EasyOpc.AlarmsAndEvents;
using OpcLabs.EasyOpc.OperationModel;

namespace DocExamples.AlarmsAndEvents._EasyAEClient
{
    class BrowseServers 
    { 
        public static void Main1()
        {
            // Instantiate the client object.
            var client = new EasyAEClient();

            ServerElementCollection serverElements;
            try
            {
                serverElements = client.BrowseServers("");
            }
            catch (OpcException opcException)
            {
                Console.WriteLine("*** Failure: {0}", opcException.GetBaseException().Message);
                return;
            }

            foreach (ServerElement serverElement in serverElements)
            {
                Debug.Assert(serverElement != null);
                Console.WriteLine("serverElements[\"{0}\"].ProgId: {1}", serverElement.Clsid, serverElement.ProgId);
            }
        }
    } 
}
' This example shows how to obtain all ProgIDs of all OPC Alarms and Events servers on the local machine.

Imports OpcLabs.EasyOpc
Imports OpcLabs.EasyOpc.AlarmsAndEvents
Imports OpcLabs.EasyOpc.OperationModel

Namespace DocExamples.AlarmsAndEvents._EasyAEClient

    Friend Class BrowseServers
        Public Shared Sub Main1()
            Dim client = New EasyAEClient()

            Dim serverElements As ServerElementCollection
            Try
                serverElements = client.BrowseServers("")
            Catch opcException As OpcException
                Console.WriteLine("*** Failure: {0}", opcException.GetBaseException().Message)
                Exit Sub
            End Try

            For Each serverElement As ServerElement In serverElements
                Debug.Assert(serverElement IsNot Nothing)
                Console.WriteLine("serverElements[""{0}""].ProgId: {1}", serverElement.Clsid, serverElement.ProgId)
            Next serverElement
        End Sub
    End Class

End Namespace
Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2012, Windows Server 2016; .NET Core, .NET 5, .NET 6: Linux, macOS, Microsoft Windows

See Also

Reference

IEasyAEClient Interface
IEasyAEClient Members