company logo

DatabaseHandle :: GetWorkspace - Get workspace names

The function returns the workspaces defined below an existing workspace or database. The function returns workspace names by index sorted in alphabetic order (first entry is retrieved with index 0). Only workspaces on a given level are returned. To get workspaces on lower levels one has to pass the root path for the lower level.

Workspace information is buffered when retrieving it the first time. To refresh the internal workspace list one should pass the refresh option (YES).

For retrieving workspaces owned by the user a user name can be passed. Not passing a user name will return all workspaces.

The name for the workspace is returned in ws_name in addition when passing a pointer to a character array. Otherwise the name is returned only in the result area of the property handle, which might be destroyed after the next property handle function call.


Return value:   - Title unknown ( NString & )

Implementation details

NString DatabaseHandle  :: GetWorkspace ( NString &ws_root, int32 ws_index, NString &user_name_w, NString &ws_info, logical refresh_opt=NO )
  • ws_root - Workspace root name or path
  • ws_index - Number of workspace to be retrieved

    This is the internal number of workspace to be retrieved. The first workspace is retrieved by index 0.

  • user_name_w - User name
  • ws_info - Additional workspace information
  • refresh_opt - Refresh option

    Setting the refresh option to true (YES) will rebuild the object completely.

    Default: NO