IWorkspaceCollection Class Reference

Provides access to members that can be used for accessing workspaces of a workspace collection. More...

#include <gdb_workspace.h>

Inheritance diagram for IWorkspaceCollection:

Public Member Functions
virtual GDBResult SDK_CALLTYPE	GetWorkspaceCount (SDKUInt32 &count) const =0 throw ()
	Returns number of workspaces in the collection.
virtual GDBResult SDK_CALLTYPE	GetWorkspaceName (SDKUInt32 index, SDKString &workspace_name) const =0 throw ()
	Returns the workspace name specified by index in collection. More...
virtual GDBResult SDK_CALLTYPE	GetWorkspace (const SDKString &name, IWorkspace **workspace)=0 throw ()
	Returns the Workspace specified by workspace name from the workspace collection.
virtual GDBResult SDK_CALLTYPE	GetWorkspaceByID (WorkspaceID id, IWorkspace **workspace)=0 throw ()
	Returns the Workspace specified by workspace identifier from the workspace collection.
virtual GDBResult SDK_CALLTYPE	GetWorkspaceByIndex (SDKUInt32 index, IWorkspace **workspace)=0 throw ()
	Returns the Workspace specified by index in the workspace collection.
virtual GDBResult SDK_CALLTYPE	RemoveWorkspace (const SDKString &workspace_name)=0 throw ()
	Removes the Workspace from the workspace collection.
virtual GDBResult SDK_CALLTYPE	AddWorkspace (const SDKString &wks_name, IWorkspace *wks, sdk::gdb::WorkspaceID &workspace_id)=0 throw ()
	Adds a Workspace into the workspace collection. 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 can be used for accessing workspaces of a workspace collection.

Member Function Documentation

GetWorkspaceName()

virtual GDBResult SDK_CALLTYPE GetWorkspaceName ( SDKUInt32  index, SDKString &  workspace_name  ) const throw ( )

pure virtual

Returns the workspace name specified by index in collection.

Parameters

[in]	index	An index in collection.
[out]	workspace_name	Address of variable that receives the name of the workspace.

Returns

Err_NotFound

AddWorkspace()

virtual GDBResult SDK_CALLTYPE AddWorkspace ( const SDKString &  wks_name, IWorkspace *  wks, sdk::gdb::WorkspaceID &  workspace_id  ) throw ( )

pure virtual

Adds a Workspace into the workspace collection.

Parameters

[in]	wks_name	The workspace name.
[in]	wks	Pointer to the IWorkspace interface that implements a Workspace.
[out]	wks_id	Address of a variable that receives the workspace identifier in the workspace collection.

Returns

Ok if succeeded

Err_InvalidArg if wks_name is NULL or wks is NULL

Err_InternalError if the number of workspace ids exceeded 256.

---

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

• gdb_workspace.h