Interface IWorkspaceFactory

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

Provides access to members that create and open workspaces and supply workspace factory information.

[Guid("F173FC16-D63A-11D1-AA81-00C04FA33A15")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IWorkspaceFactory

Remarks

A WorkspaceFactory is a dispenser of workspaces and allows a client to connect to a workspace specified by a set of connection properties. A workspace represents a database or a datasource that contains one or more datasets. Examples of datasets include tables, feature classes and relationship classes. A WorkspaceFactory is a cocreatable, singleton object. Connection properties are specified using a PropertySet object and can be saved to a connection file. A WorkspaceFactory also supports methods that can be used to browse and manage file system workspaces, and methods to manage connection files for remote database workspaces.

Each workspace factory maintains a pool of currently connected, active workspaces that are referenced by the application. When any of the Open* methods is called, the workspace factory first checks to see if a workspace has previously been opened with a matching set of properties. If so, a reference to the existing instance is returned. In the case of ArcSDE workspaces, when an application connects to a workspace but omits some connection properties (such as username, password, or version), the workspace factory will check a set of "core" properties - SERVER, INSTANCE, and AUTHENTICATION_MODE - to see they match any open workspaces. If so, the workspace factory will return a reference to the matching workspace.

Properties

WorkspaceDescription[bool]

A singular or plural description of the type of workspace the workspace factory opens/creates.

string WorkspaceDescription[bool plural] { get; }

Parameters

plural bool

Property Value

string

Remarks

The plural parameter is used as a helper that will take and make the workspacefactory plural. e.g. SDE Connection will become SDE Connections.

WorkspaceType

The type of workspace the workspace factory opens/creates.

esriWorkspaceType WorkspaceType { get; }

Property Value

esriWorkspaceType

Remarks

The WorkspaceType property of a WorkspaceFactory returns information on the type of workspace managed by the WorkspaceFactory. Workspaces are classified into the following types specified by the esriWorkspaceType enumeration; FileSystemWorkspace, LocalDatabaseWorkspace, and RemoteDatabaseWorkspace.
See esriWorkspaceType for information on the types of workspaces.
Shapefiles workspaces are examples of FileSystemWorkspace. Personal and File Geodatabases are examples of LocalDatabaseWorkspace. An ArcSDE Geodatabase is an example of a RemoteDatabaseWorkspace.

Methods

ContainsWorkspace(string, IFileNames)

Indicates if parentDirectory contains a valid workspace, or is a valid file-system workspace.

bool ContainsWorkspace(string parentDirectory, IFileNames fileNames)

Parameters

parentDirectory string
fileNames IFileNames

Returns

bool

Remarks

ContainsWorkspace is useful when browsing the file system for workspaces. It takes a parent directory and the list of file names in the directory to be examined. It returns true if the parent directory represents a workspace covered by this factory or if the parent directory contains a workspace or a connection file to a workspace covered by this factory.

Copy(IWorkspaceName, string, out IWorkspaceName)

Copies a workspace to the specified destination folder.

bool Copy(IWorkspaceName WorkspaceName, string destinationFolder, out IWorkspaceName workspaceNameCopy)

Parameters

WorkspaceName IWorkspaceName
destinationFolder string
workspaceNameCopy IWorkspaceName

Returns

bool

Remarks

The Copy and Move methods can be used to copy or move workspaces or connection files between folders in the file system. The Boolean result indicates if the operation was successful. In the case of remote database workspaces, these operations work on the connection file representing the workspace.

Create(string, string, IPropertySet, int)

Creates a new workspace specified by the directory, file name, and connection properties.

IWorkspaceName Create(string parentDirectory, string Name, IPropertySet ConnectionProperties, int hWnd)

Parameters

parentDirectory string
Name string
ConnectionProperties IPropertySet
hWnd int

Returns

IWorkspaceName

Remarks

Create has different results depending on the type of workspace factory. If you are working with ArcSDE, a new connection file (.sde) is created. If you are working with an ArcGIS for Desktop Advanced workspace factory, a folder with an INFO subfolder is created. The optional ConnectionProperties parameter specifies any additional connection properties needed, such as the server, instance, user and password in the case where a connection file to a remote database workspace is being created. If no connection properties are specified, this method will result in a dialog being displayed that prompts the user for the required properties.

GetClassID()

The class ID of the WorkspaceFactory.

UID GetClassID()

Returns

UID

Remarks

GetClassID returns the unique identifier for the workspace factory. You can use this to distinguish different versions of the same type of factory, for example, whether you are working with an SDEWorkspace, FileGDBWorkspace or AccessWorkspace factory.

GetWorkspaceName(string, IFileNames)

Retrieves the workspace name of a workspace from the given list of file names.

IWorkspaceName GetWorkspaceName(string parentDirectory, IFileNames fileNames)

Parameters

parentDirectory string
fileNames IFileNames

Returns

IWorkspaceName

Remarks

GetWorkspaceName is useful when browsing the file system for workspaces. It is handed in a parent directory and the list of file names in the directory to be examined. It returns a WorkspaceName object representing the first workspace it finds in the list of filenames and removes any filenames representing the workspace from the input list of filenames.

IsWorkspace(string)

True if the specified file identifies a workspace supported by the workspace factory.

bool IsWorkspace(string fileName)

Parameters

fileName string

Returns

bool

Move(IWorkspaceName, string)

Moves a workspace to the specified destination folder.

bool Move(IWorkspaceName WorkspaceName, string destinationFolder)

Parameters

WorkspaceName IWorkspaceName
destinationFolder string

Returns

bool

Remarks

The Copy and Move methods can be used to copy or move workspaces or connection files between folders in the file system. The Boolean result indicates if the operation was successful. In the case of remote database workspaces, these operations work on the connection file representing the workspace.

Open(IPropertySet, int)

Opens the workspace specified by the connection properties.

IWorkspace Open(IPropertySet ConnectionProperties, int hWnd)

Parameters

ConnectionProperties IPropertySet
hWnd int

Returns

IWorkspace

Remarks

Open takes as input a property set of connection properties that specify the workspace to connect to. In the case of file system workspaces and local database workspaces, a single property named DATABASE, whose value is the pathname to the workspace, is usually all that is required. In the case of remote database workspaces accessed via ArcSDE the properties can include the USER, PASSWORD, DATABASE, SERVER, INSTANCE, VERSION, HISTORICAL_NAME, HISTORICAL_TIMESTAMP, and AUTHENTICATION_MODE properties of the database being connected to.

List of acceptable connection property names and a brief description of each

"SERVER" – SDE server name you are connecting to.

"INSTANCE" – Instance you are connection to.

"DATABASE" – Database connected to.

"USER" – Connected user.

"PASSWORD" – Connected password.

"AUTHENTICATION_MODE" – Credential authentication mode of the connection. Acceptable values are "OSA" and "DBMS".

"VERSION" – Transactional version to connect to. Acceptable value is a string that represents a transaction version name.

"HISTORICAL_NAME" – Historical version to connect to. Acceptable value is a string type that represents a historical marker name.

"HISTORICAL_TIMESTAMP" – Moment in history to establish an historical version connection. Acceptable value is a date time that represents a moment timestamp.

 

Notes:

  • The "DATABASE" property is optional and is required for ArcSDE instances that manage multiple databases (for example, SQL Server).
  • If “AUTHENTICATION_MODE” is “OSA” then “USER” and “PASSWORD” are not required. “OSA” represents operating system authentication and uses the operating system credentials to establish a connection with the database.
  • Since the workspace connection can only represent one version only 1 of the 3 version properties (“VERSION” or “HISTORICAL_NAME” or “HISTORICAL_TIMESTAMP”) should be used.
  • The "VERSION" property is case sensitive and the correct case must be used when entering the version property.

OpenFromFile(string, int)

Opens the workspace specified by the given file name.

IWorkspace OpenFromFile(string fileName, int hWnd)

Parameters

fileName string
hWnd int

Returns

IWorkspace

Remarks

OpenFromFile takes the pathname of a file or directory that represents either a FileSystemWorkspace or LocalDatabaseWorkspace, or a connection file to a RemoteDatabase workspace and returns an interface on the specified workspace. Clients of these methods can then proceed to open and access datasets in the workspace. If these methods are called with insufficient properties, then the user will be presented with a connection dialog that will prompt for the required properties.

The hWnd argument is the parent window or application's window. The hWnd will guarantee that the connection dialog, if presented to you because of insufficient properties, has the correct parent.

ReadConnectionPropertiesFromFile(string)

The connection properties from the specified file.

IPropertySet ReadConnectionPropertiesFromFile(string fileName)

Parameters

fileName string

Returns

IPropertySet

Remarks

The filename parameter represents the pathname of a file that contains the connection information to be placed into the IPropertySet variable.