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

#include <gdb_workspace.h>

Inheritance diagram for IWorkspaceFactory:

Public Member Functions
virtual GDBResult SDK_CALLTYPE	Open (IWorkspaceConfiguration configuration, IWorkspace *workspace)=0 throw ()
	Opens the workspace specified by the properties. More...

virtual GDBResult SDK_CALLTYPE	OpenRootCatalog (const SDKString &root_catalog_path_name, IRootCatalog **root_catalog)=0 throw ()
	Opens the geodatabase root catalog. More...

virtual GDBResult SDK_CALLTYPE	OpenFromFile (const SDKString &file_name, IWorkspaceConfiguration configuration, IWorkspace *workspace)=0 throw ()
	Opens the workspace specified by the given file name. More...

virtual GDBResult SDK_CALLTYPE	Create (IWorkspaceConfiguration config, IWorkspace *workspace)=0 throw ()
	Creates an empty workspace. More...

virtual GDBResult SDK_CALLTYPE	CreateWorkspaceConfiguration (IWorkspaceConfiguration **config)=0 throw ()
	Creates an empty workspace configuration. More...

virtual GDBResult SDK_CALLTYPE	GetWorkspaces (IWorkspaceCollection **workspaces)=0 throw ()
	The GetWorkspaces method returns the pointer to the IWorkspaceCollection interface associated with the collection of workspaces created or opened by the workspace factory.

virtual GDBResult SDK_CALLTYPE	GetGeodatabasesNamesFromWKNLocation (IEnumSDKString *names, SDKString geodatabase_wkn_location) const =0 throw ()
	Returns names of the geodatabases located in the directory specified in the SDK configuration as a known location for the geodatabases. More...

virtual GDBResult SDK_CALLTYPE	ChangeGeodatabasesWKNLocation (const SDKString &new_location)=0 throw ()
	Changes the geodatabase WKN location in the SDK configuration. More...

virtual GDBResult SDK_CALLTYPE	OpenFeatureCatalog (const SDKAny &pathname_or_prsp, IClassCatalog **class_catalog)=0 throw ()
	Opens a feature catalog specified by pathname. More...

virtual GDBResult SDK_CALLTYPE	OpenUpdateHistory (IRootCatalog root_catalog, IWorkspaceUpdateHistory *update_history)=0 throw ()
	Returns the IWorkspaceUpdateHistory interface associated with the workspace update history. More...

virtual GDBResult SDK_CALLTYPE	OpenRootCatalogEx (IWorkspaceConfiguration configuration, IRootCatalog *root_catalog)=0 throw ()
	Opens the geodatabase root catalog. More...

Public Member Functions inherited from ISDKComponent
virtual SDKAtomicRefCount SDK_CALLTYPE	AddRef () const =0 throw ()
	Increments the reference count for an interface on a component.

virtual SDKAtomicRefCount SDK_CALLTYPE	Release () const =0 throw ()
	Decrements the reference count for an interface on a component.

virtual SDKResult SDK_CALLTYPE	GetInterface (const InterfaceId &id, void **obj_ptr)=0 throw ()
	Returns pointers to the supported interfaces on a component.

template<typename _Itf >
SDKResult	GetInterface (_Itf **obj_ptr) throw ()
	Returns pointers to the supported interfaces on a component.

Detailed Description

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

Member Function Documentation

◆ Open()

virtual GDBResult SDK_CALLTYPE Open	(	IWorkspaceConfiguration *	configuration,
		IWorkspace **	workspace
	)
throw	(
	)

pure virtual

Opens the workspace specified by the properties.

Parameters

[in]	configuration	Pointer to the IWorkspaceConfiguration interface associated with a workspace configuration.
[out]	workspace	Address of a variable that receives the pointer to the IWorkspace interface associated with a workspace. If this parameter is NULL, the method returns kSDKResult_Succeeded if a SENC was found on specified path.

Returns: kSDKResult_Succeeded; kSDKResult_NotFound; kSDKResult_InvalidArgument

◆ OpenRootCatalog()

virtual GDBResult SDK_CALLTYPE OpenRootCatalog	(	const SDKString &	root_catalog_path_name,
		IRootCatalog **	root_catalog
	)
throw	(
	)

pure virtual

Opens the geodatabase root catalog.

Parameters

[in]	root_catalog_path_name	Path to the root catalog.
[out]	root_catalog	Address of a variable that receives the pointer to the IRootCatalog interface associated with the root catalog object.

Returns: kSDKResult_Succeeded; kSDKResult_NotFound; kSDKResult_InvalidArgument

◆ OpenFromFile()

virtual GDBResult SDK_CALLTYPE OpenFromFile	(	const SDKString &	file_name,
		IWorkspaceConfiguration *	configuration,
		IWorkspace **	workspace
	)
throw	(
	)

pure virtual

Opens the workspace specified by the given file name.

Parameters

	file_name	[in] File name of a geodatabase. The file name specifies either a root catalog or a single dataset.
[in]	configuration	Pointer to the IWorkspaceConfiguration interface associated with a workspace configuration.
	workspace	[out] Address of a variable that receives the pointer to the IWorkspace interface associated with a workspace. If this parameter is NULL, the method returns kSDKResult_Succeeded if a SENC was found on specified path.

Returns: kSDKResult_Succeeded; kSDKResult_NotImplemented; kSDKResult_NotFound; kSDKResult_InvalidArgument

◆ Create()

virtual GDBResult SDK_CALLTYPE Create	(	IWorkspaceConfiguration *	config,
		IWorkspace **	workspace
	)
throw	(
	)

pure virtual

Creates an empty workspace.

Parameters

[in]	config	Pointer to the IWorkspaceConfiguration interface associated with a workspace configuration.
[out]	workspace	Address of a variable that receives the pointer to the IWorkspace interface associated with a workspace.

Returns: kSDKResult_Succeeded; kSDKResult_NotImplemented; kSDKResult_InvalidArgument

◆ CreateWorkspaceConfiguration()

virtual GDBResult SDK_CALLTYPE CreateWorkspaceConfiguration	(	IWorkspaceConfiguration **	config	)
throw	(
	)

pure virtual

Creates an empty workspace configuration.

Parameters

[out] config Address of a variable that receives the pointer to the IWorkspaceConfiguration interface associated with a workspace configuration.

Returns: Ok; Err_NotImpl; Err_InvalidArg

◆ GetGeodatabasesNamesFromWKNLocation()

virtual GDBResult SDK_CALLTYPE GetGeodatabasesNamesFromWKNLocation	(	IEnumSDKString **	names,
		SDKString *	geodatabase_wkn_location
	)		const
throw	(
	)

pure virtual

Returns names of the geodatabases located in the directory specified in the SDK configuration as a known location for the geodatabases.

Parameters

[out]	names	(optional) Address of a variable that receives the pointer to the IEnumSDKString interface associated with the geodatabase name enumerator.
[out]	geodatabase_wkn_location	(optional) Address of a variable that receives path to the WKN location.

Returns: kSDKResult_Succeeded if the enumerator is not empty.; kSDKResult_NotExist if there is not databases in the configured location.

◆ ChangeGeodatabasesWKNLocation()

virtual GDBResult SDK_CALLTYPE ChangeGeodatabasesWKNLocation	(	const SDKString &	new_location	)
throw	(
	)

pure virtual

Changes the geodatabase WKN location in the SDK configuration.

Parameters

[in] new_location Path for the new WKN location.

Returns: kSDKResult_Succeeded if path exists and accessible.

◆ OpenFeatureCatalog()

virtual GDBResult SDK_CALLTYPE OpenFeatureCatalog	(	const SDKAny &	pathname_or_prsp,
		IClassCatalog **	class_catalog
	)
throw	(
	)

pure virtual

Opens a feature catalog specified by pathname.

Parameters

[in]	pathname_or_prsp	A feature catalog pathname or PRSP.
[out]	class_catalog	Address of a variable that receives the pointer to the IClassCatalog interface associated with a feature catalog.

Returns: kSDKResult_Succeeded or an error if failed

◆ OpenUpdateHistory()

virtual GDBResult SDK_CALLTYPE OpenUpdateHistory	(	IRootCatalog *	root_catalog,
		IWorkspaceUpdateHistory **	update_history
	)
throw	(
	)

pure virtual

Returns the IWorkspaceUpdateHistory interface associated with the workspace update history.

Parameters

[in]	root_catalog	Route catalog.
[out]	update_history	Address of a variable that receives the pointer to the IWorkspaceUpdateHistory interface associated with the workspace history.

Returns: kSDKResult_Succeeded or an error if failed

◆ OpenRootCatalogEx()

virtual GDBResult SDK_CALLTYPE OpenRootCatalogEx	(	IWorkspaceConfiguration *	configuration,
		IRootCatalog **	root_catalog
	)
throw	(
	)

pure virtual

Opens the geodatabase root catalog.

Parameters

[in]	configuration	Pointer to the IWorkspaceConfiguration interface associated with a workspace configuration.
[out]	root_catalog	Address of a variable that receives the pointer to the IRootCatalog interface associated with the root catalog object.

Returns: kSDKResult_Succeeded; kSDKResult_NotFound; kSDKResult_InvalidArgument

The documentation for this class was generated from the following file:

gdb_workspace.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ Open()

◆ OpenRootCatalog()

◆ OpenFromFile()

◆ Create()

◆ CreateWorkspaceConfiguration()

◆ GetGeodatabasesNamesFromWKNLocation()

◆ ChangeGeodatabasesWKNLocation()

◆ OpenFeatureCatalog()

◆ OpenUpdateHistory()

◆ OpenRootCatalogEx()