com.esri.arcgis.geodatabase
Interface IWorkspaceExtensionManager

All Superinterfaces:
Serializable
All Known Implementing Classes:
IWorkspaceExtensionManagerProxy, VersionedWorkspace, Workspace

public interface IWorkspaceExtensionManager
extends Serializable

Provides access to members that manage a workspace extension.

Remarks

IWorkspaceExtensionManager is an optional interface supported by Personal, File and ArcSDE geodatabase workspaces. The FindExtension method returns a reference to a workspace extension given its GUID. An application can also discover and iterate over all extensions using the ExtensionCount and Extension properties.

Product Availability

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

See Also:
IWorkspace

Method Summary
 IWorkspaceExtension findExtension(IUID pGUID)
          Finds the specified workspace extension by its globally unique id.
 IWorkspaceExtension getExtension(int index)
          The workspace extension at this index.
 int getExtensionCount()
          The number of workspace extensions.
 void registerExtension(String name, IUID pGUID)
          Registers this workspace extension with the database making it required for successful connection to this database.
 void unRegisterExtension(IUID pGUID)
          UnRegisters this workspace extension making it no longer required for successful connection to this database.
 

Method Detail

findExtension

IWorkspaceExtension findExtension(IUID pGUID)
                                  throws IOException,
                                         AutomationException
Finds the specified workspace extension by its globally unique id.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pGUID - A reference to a com.esri.arcgis.system.IUID (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspaceExtension
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionCount

int getExtensionCount()
                      throws IOException,
                             AutomationException
The number of workspace extensions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtension

IWorkspaceExtension getExtension(int index)
                                 throws IOException,
                                        AutomationException
The workspace extension at this index.

Product Availability

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

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspaceExtension
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

registerExtension

void registerExtension(String name,
                       IUID pGUID)
                       throws IOException,
                              AutomationException
Registers this workspace extension with the database making it required for successful connection to this database.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
pGUID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unRegisterExtension

void unRegisterExtension(IUID pGUID)
                         throws IOException,
                                AutomationException
UnRegisters this workspace extension making it no longer required for successful connection to this database.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pGUID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.