Interface IWorkspaceStatus

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll

Describes the status of a workspace.

[Guid("BBE342C6-2618-4540-95B5-D6A82F618DFA")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IWorkspaceStatus

Remarks

The IWorkspaceFactoryStatus::WorkspaceStatus property returns an enumeration of IWorkspaceStatus objects for all currently open workspaces. This property should be used as a course grained object to determine the current status of the workspace connection (esriWCSUp or esriWCSDown). Use IWorkspaceStatus::ConnectionStatus property to determine the status of a particular workspace. The values of esriWorkspaceConnectionStatus returned by the IWorkspaceFactoryStatus::WorkspaceStatus property are:

·                 esriWCSUp indicates that the workspace is up.

·                 esriWCSDown indicates that the workspace has lost its connection.

If the status of a workspace connection is esriWCSDown a reconnection can be made to the workspace once the workspace becomes available for reconnection. It is recommended to use the IWorkspaceFactoryStatus::PingWorkspaceStatus method to obtain the current status of the down workspace. If the connection status has changed from esriWCSDown to esriWCSAvailable the IWorkspaceFactoryStatus::OpenAvailableWorkspace method can be used to get a reference to the workspace.

Note that IWorkspaceFactoryStatus::OpenAvailableWorkspace does not repair the original workspace, but provides a mechanism to get a new one when reconnection is possible. It is the responsibility of the application to refresh other objects that rely on the new workspace (for example, opening a feature class from the new workspace and setting it into a feature layer).

Properties

ConnectionStatus

The current connection status of the workspace.

esriWorkspaceConnectionStatus ConnectionStatus { get; }

Property Value

esriWorkspaceConnectionStatus

Workspace

The workspace this status refers to.

IWorkspace Workspace { get; }

Property Value

IWorkspace

Remarks

<p>A Workspace is a container of spatial and non-spatial datasets such as feature classes, raster datasets, and tables. It provides methods to instantiate existing datasets and to create new datasets. Workspaces are classified into types specified by the <b><a href="esriWorkspaceType.htm">esriWorkspaceType</a></b> enumerator: FileSystemWorkspace, LocalDatabaseWorkspace, and RemoteDatabaseWorkspace. Shapefiles and ArcGIS for Desktop Advanced workspaces are examples of FileSystemWorkspace. A personal geodatabase stored in an Access or a File Geodatabase is an example of a LocalDatabaseWorkspace. A geodatabase stored in an RDBMS such as Oracle, DB2, SQL Server, or Informix and accessed via ArcSDE is an example of a RemoteDatabaseWorkspace.</p> <p>A Workspace hands out a <b><a href="WorkspaceName.htm">WorkspaceName</a> </b>object as the value of its FullName property. For example, the WorkspaceName for a workspace can be persisted in a map document. An application can call the <b>Open()</b> method on the workspace name after loading it from persistent storage to connect to and get an object reference to the workspace.</p>