This document is archived and information here might be outdated.  Recommended version.

AGSServerConnection Class (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > GISClient > ESRI.ArcGIS.GISClient > Classes > A > AGSServerConnection Class
ArcGIS Developer Help

AGSServerConnectionClass Class

The AGSServerConnection object for connecting to the GIS server and getting the ServerObjectManager and ServerObjectAdmin.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Extended Error Information

Use the ISupportErrorInfo method InterfaceSupportsErrorInfo to determine if the object supports extended error information. If the object supports extended error info, VC++ developers should use the OLE/COM IErrorInfo interface to access the ErrorInfo object. Visual Basic developers should use the global error object Err to retrieve this extended error information.


Interfaces Description
IAGSServerConnection Provides access to members that have information about the GIS server connection..
IAGSServerConnection2 Provides access to members that create and open GIS server connections and supply server connection factory information.
IAGSServerConnection3 Provides access to members that have information about the GIS server connection..
IAGSServerConnectionAdmin Provides access to the server object manager, server object admin and server object configurations for the GIS server.
ISupportErrorInfo (esriSystem)


An AGSServerConnection is a connection to a GIS server or web service catalog. Both contain server objects such as MapServer and GeocodeServer server objects. It provides methods to get references to server objects. If the AGSServerConnection is a direct connection to the GIS server over a LAN, there are methods to get references to the ServerObjectManager and ServerObjectAdmin objects for the GIS server.

An AGSServerConnection hands out a AGSServerConnectionName name object as the value of its FullName property. The AGSServerConnectionName for an AGSServerConnection can be persisted, for example, in a map document. An application can call the Open method on the AGSServerConnection name after loading it from persistent storage in order to connect to and get an object reference to the GIS server or web service catalog.

The MapServer and GeocodeServer objects that you obtain through an AGSServerConnection support only the coarse-grained, stateless methods associated with the server object. You can't use a MapServer or GeocodeServer object obtained from an AGSServerConnection to get references to the finer-grained objects associated with the server object, not can you change any aspects of the server object's state. Server objects obtained from LAN connections or web service catalog AGSServerConnections can be used in the same way, so if you are writing applications that need to work with both LAN and web service catalog conneciton to a GIS server, use AGSServerConnection and its associated objects.

When you get a server object using the ArcCatalog objects (GxAGSServerConnection) and ArcMap (MapServerLayer), you are working through an AGSServerConnection.

If you want to work with a server object in a stateful manner, or you want to work with the finer-grained ArcObjects associated with a server object, you must obtain that server object by getting a reference to its server context from the ServerObjectManager . You can get the ServerObjectManager by either connecting to the GIS server using a GISServerConnection object, or by getting it from the AGSServerConnection.

See Also

AGSServerConnectionFactory Class | GISServerConnection Class | IServerObjectManager Interface | IServerObject Interface | GISServerConnection Class | IServerObjectAdmin Interface | IServerContext Interface | ServerObjectManager Class | IGISServerConnection Interface | AGSServerObjectName Class