com.esri.arcgis.system
Interface ITestConnection

All Superinterfaces:

Serializable

All Known Implementing Classes:

IMSServiceName

public interface ITestConnection
extends Serializable

Provides access to members that test connection for a preset configuration.

Description

If any type of coclass has provide a method to test preconfigured connection, it could implement ITestConnection interface. This method returns a boolean to indicate if the connection failed or passed. In case the connection failed, the implementing coclass is expected to return the appropriate HRESULT indicate what was the cause of the failure.

Product Availability

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

Method Summary

boolean

testConnection() Tests if the connection is successful with the current configuration.

Method Detail

testConnection

boolean testConnection()
                       throws IOException,
                              AutomationException

Tests if the connection is successful with the current configuration.

Description

Returns the indication whether the connection failed or passed.

Product Availability

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

Returns:

The successful

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.