IWorkspaceConfiguration Class Reference

Provides access to the workspace configuration. More...

#include <gdb_workspace.h>

Inheritance diagram for IWorkspaceConfiguration:

Public Member Functions
virtual GDBResult SDK_CALLTYPE	GetName (SDKString &name) const =0 throw ()
	Returns the workspace name. More...
virtual GDBResult SDK_CALLTYPE	GetRootPath (SDKString &path) const =0 throw ()
	Returns the workspace root path. More...
virtual GDBResult SDK_CALLTYPE	GetRootCatalogName (SDKString &name) const =0 throw ()
	Returns the workspace root catalog name. More...
virtual GDBResult SDK_CALLTYPE	GetFlags (WorkspaceFlags &flags) const =0 throw ()
	Returns the workspace flags. More...
virtual GDBResult SDK_CALLTYPE	GetConfigurationParameter (WorkspaceConfigurationParameterId parameter_id, SDKAny &value) const =0 throw ()
	Returns the value of the specified parameter. More...
virtual GDBResult SDK_CALLTYPE	SetConfigurationParameter (WorkspaceConfigurationParameterId parameter_id, const SDKAny &value)=0 throw ()
	Sets the value of the specified parameter. 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 the workspace configuration.

Member Function Documentation

GetName()

virtual GDBResult SDK_CALLTYPE GetName ( SDKString &  name ) const throw ( )

pure virtual

Returns the workspace name.

Parameters

[out]

name

Address of a variable that receives the workspace name.

Returns

Ok if succeeded

Err_NotExist

GetRootPath()

virtual GDBResult SDK_CALLTYPE GetRootPath ( SDKString &  path ) const throw ( )

pure virtual

Returns the workspace root path.

Parameters

[out]

path

Address of a variable that receives the workspace root path.

Returns

Ok if succeeded

Err_NotExist

GetRootCatalogName()

virtual GDBResult SDK_CALLTYPE GetRootCatalogName ( SDKString &  name ) const throw ( )

pure virtual

Returns the workspace root catalog name.

Parameters

[out]

name

Address of a variable that receives the workspace root catalog name.

Returns

Ok if succeeded

Err_NotExist

GetFlags()

virtual GDBResult SDK_CALLTYPE GetFlags ( WorkspaceFlags &  flags ) const throw ( )

pure virtual

Returns the workspace flags.

Parameters

[out]

flags

Address of a variable that receives the workspace flags.

Returns

Ok if succeeded

Err_NotExist

GetConfigurationParameter()

virtual GDBResult SDK_CALLTYPE GetConfigurationParameter ( WorkspaceConfigurationParameterId  parameter_id, SDKAny &  value  ) const throw ( )

pure virtual

Returns the value of the specified parameter.

Parameters

[in]	parameter_id	Identifier of a workspace configuration parameter.
[out]	value	The value of the specified parameter.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_NotFound

SetConfigurationParameter()

virtual GDBResult SDK_CALLTYPE SetConfigurationParameter ( WorkspaceConfigurationParameterId  parameter_id, const SDKAny &  value  ) throw ( )

pure virtual

Sets the value of the specified parameter.

Parameters

[in]	parameter_id	Identifier of a workspace configuration parameter.
[in]	value	The value of the specified parameter.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_NotFound

---

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

• gdb_workspace.h