com.esri.arcgis.gisclient
Interface IWMSConnectionName

All Superinterfaces:

Serializable

All Known Implementing Classes:

WMSConnectionName

public interface IWMSConnectionName
extends Serializable

Provides access to members that supply WMS server connection name information.

Remarks

IWMSConnectionName provides a property (ConnectionProperties) to hold server connection properties and a method (OpenEx) that returns the connection once these properties have been set.

Product Availability

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

Method Summary

IPropertySet	getConnectionProperties() Connection properties that will be used to connect to the WMS server.
Object	openEx(ITrackCancel pTrackCancel) Opens the WMS Connection.
void	setConnectionProperties(IPropertySet connectionProperties) Connection properties that will be used to connect to the WMS server.

Method Detail

setConnectionProperties

void setConnectionProperties(IPropertySet connectionProperties)
                             throws IOException,
                                    AutomationException

Connection properties that will be used to connect to the WMS server.

Product Availability

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

Parameters:

connectionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionProperties

IPropertySet getConnectionProperties()
                                     throws IOException,
                                            AutomationException

Connection properties that will be used to connect to the WMS server.

Remarks

ConnectionProperties is named value pairs relating to WMS service connection. This is where you would set the WMS server URL. Relevant names include “URL”, which is the minimum required, and three optional names: "VERSION', which specifies the WMS version, and two names, “USER” and “PASSWORD” that can be used when connecting to a WMS service over HTTPS.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openEx

Object openEx(ITrackCancel pTrackCancel)
              throws IOException,
                     AutomationException

Opens the WMS Connection.

Remarks

OpenEx returns a WMSConnection.

Product Availability

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

Parameters:

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.