Database :: workspaceName - Get workspace names
The function returns the workspace defined below an existing workspace (sWorkspaceRoot) or database (sWorkspaceRoot root is empty). The function returns workspace names by number passed in iWorkspaceIndex sorted in alphabetic order (first entry is retrieved with 0). Only sub workspaces for the current workspace are returned. To get workspaces on lower levels you must pass the root path for the lower level.
Workspace information is buffered when retrieving it the first time. To refresh the internal workspace list you should pass true in bRefresh.
For retrieving workspaces owned by a group or user, a group or user name can be passed in sUserName. Not passing a user name will return all workspaces.
The workspace name is the extension of the current workspace or database. The database can be considered as the root for all workspaces. The workspace name may address a workspace on top of the current one (simple workspace name) or a workspace on any higher level by passing a sequence of workspace names separated by '.'.
In order to pass no dictionary path, an empty string ( String() ) has to be passed.
Implementation details
- sWorkspaceRoot
- Workspace root name or path
The workspace root name or path is provided as 0-terminated string. A workspace path may contain several workspace names in a workspace hierarchy separated by '.'.
- iWorkspaceIndex
- Index of workspace to be retrieved
This is the internal number of workspace to be retrieved. The first workspace is retrieved by index 0.
- sUserName
- User name
The user name is the user's login name. In order not to pass any user name, an empty string ( String() )may be passed.
- bRefresh
- Refresh option
Setting the refresh option to true will rebuild the object completely.