company logo

DatabaseHandle :: OpenWorkspace - Open Workspace

The function creates or opens an existing workspace. After opening the workspace all updates are stored in the opened workspace. When the workspace is used the first time it is created automatically. When it does already exist the existing workspace is opened. You can check whether a workspace exists using the LocateWorkspace() function, which returns true when the workspace has already been created.

Usually the workspace file is created in the same folder as the database. You may, however, pass an explicit location for the workspace via the ws_path parameter.

Return value:  Success ( logical  )

Implementation details

logical DatabaseHandle  :: OpenWorkspace ( NString &ws_name, NString &user_name_w, logical exclusive_w=NO, NPath &cpath_w=NPath() )
  • ws_name - Workspace name

    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 '.'.

  • user_name_w - User name
  • exclusive_w - Open workspace exclusively Default: NO
  • cpath_w - cpath_w - Title unknown Default: NPath()