STx 3.9 Documentation

Book

Class Library

Previous Class

SETTEXT text

Next Class

BSTXIni Member Functions

BSTXIni : BXMLDoc

This class implements the XML Workspace document. The Workspace document contains the S_TOOLS-STx configuration and the settings and is implemented as a global object which can be accessed from all S_TOOLS-STx applications and scripts. The user must not create or destroy the Workspace object because these functions are performed by the application startup and cleanup macros. At application startup a BSTXINI instance is created and linked to the global Workspace document. The name of is instance is stored in the shell variable BSTXINI. This object must (!) be used to access the Workspace document.

This class also implements a set of static functions which are used by the master application and the application DataSet to manage to file STX.INI which contains the name of the last used Workspace file (for program startup) and the DataSet file history.

The automatic Workspace version update and some installation and licence checks are also implemented by this class, but not described in this documentation.

Please use the ATTACH and DETACH functions from the base class BXMLDOC before carrying out any actions on shared documents.

!! Never call the member functions CONSTRUCT, DESTRUCT, CLOSE or LOAD !!

In This Class

BSTXIni Member Functions

© 2009 The Austrian Academy of Sciences Acoustics Research Institute