Programmer Guide/Macro Library/BSTXIni - Revision history

Jw: /* Load a Profile */

2018-07-23T09:41:38Z

Load a Profile

← Older revision		Revision as of 11:41, 23 July 2018
Line 87:		Line 87:
	:;<var>tid</var>: the id of the profile template		:;<var>tid</var>: the id of the profile template
	:;<var>subsets</var>: the xml path (partial iref) of the element containing the profile		:;<var>subsets</var>: the xml path (partial iref) of the element containing the profile
	;Result: Returns a simple or extended table (depends on the profile) containing the profile settings. If the profile <var>id</var> do not exist, it is created from the template <var>tid</var> and ~~than~~ loaded.		;Result: Returns a simple or extended table (depends on the profile) containing the profile settings. If the profile <var>id</var> do not exist, it is created from the template <var>tid</var> and then loaded.

	===Save a Profile===		===Save a Profile===

2018-03-02T15:52:17Z

← Older revision		Revision as of 17:52, 2 March 2018
Line 100:		Line 100:

	===Delete a profile===		===Delete a profile===
	;Usage: <code>$bstxini deletesetupelement <var>tag ; id ; </var></code>		;Usage: <code>$bstxini deletesetupelement <var>tag ; id ; subsets</var></code>
			:;<var>tag</var>: the xml tag of the profile
			:;<var>id</var>: the id of the profile
			:;<var>subsets</var>: the xml path (partial iref) of the element containing the profile
			;Result: '''0''' if profile was deleted for successfully or a non-zero error code

	==Uncommon Functions and Functions for internal use only==		==Uncommon Functions and Functions for internal use only==
Line 115:		Line 119:
	* <code>Save</code>: save workspace document		* <code>Save</code>: save workspace document
	* <code>Save</code>: close workspace document - only used by application manager!		* <code>Save</code>: close workspace document - only used by application manager!

			* <code>DialogNewSetupElement</code>: a dialog to create a settings profile

2018-03-02T15:04:24Z

← Older revision		Revision as of 17:04, 2 March 2018
Line 100:		Line 100:

	===Delete a profile===		===Delete a profile===
	;Usage: <code>$bstxini deletesetupelement <var>tag ; id ; </var><code>		;Usage: <code>$bstxini deletesetupelement <var>tag ; id ; </var></code>

	==Uncommon Functions and Functions for internal use only==		==Uncommon Functions and Functions for internal use only==

2018-03-02T15:03:53Z

← Older revision		Revision as of 17:03, 2 March 2018
Line 63:		Line 63:

	===Get Application Shell or Name===		===Get Application Shell or Name===
	;Usage: <code>$bstxini getapp <var>appname shellid=*</var>		;Usage: <code>$bstxini getapp <var>appname shellid=*</var></code>
	;Result:		;Result:
	::* if <var>shellid</var> equals '''*''': return the shell-id of the application named <var>appname</var> or an empty string if not running; if multiple instances of this application are running, a blank separated list of shell-ids is returned		::* if <var>shellid</var> equals '''*''': return the shell-id of the application named <var>appname</var> or an empty string if not running; if multiple instances of this application are running, a blank separated list of shell-ids is returned

2018-03-02T15:03:17Z

← Older revision		Revision as of 17:03, 2 March 2018
Line 72:		Line 72:

	===Get a List of Profiles===		===Get a List of Profiles===
	;Usage: <code>$bstxini listprofiles <var>table ; tag ; id ; subset</code>		;Usage: <code>$bstxini listprofiles <var>table ; tag ; id ; subset</var></code>
	:;<var>table</var>: a simple table to store results; if no table is passed, it is created		:;<var>table</var>: a simple table to store results; if no table is passed, it is created
	:;<var>tag</var>: the xml tag of the profiles		:;<var>tag</var>: the xml tag of the profiles

2018-03-02T15:02:45Z

← Older revision		Revision as of 17:02, 2 March 2018
Line 100:		Line 100:

	===Delete a profile===		===Delete a profile===
	;Usage: <code>$bstxini deletesetupelement <var>tag ; id ; <code>		;Usage: <code>$bstxini deletesetupelement <var>tag ; id ; </var><code>

	==Uncommon Functions and Functions for internal use only==		==Uncommon Functions and Functions for internal use only==

2018-03-02T15:02:04Z

← Older revision		Revision as of 17:02, 2 March 2018
Line 90:		Line 90:

	===Save a Profile===		===Save a Profile===
	;Usage: <code>$bstxini savesetupelement <var>table ; del ; tag ; id ; subset</code>		;Usage: <code>$bstxini savesetupelement <var>table ; del ; tag ; id ; subset</var></code>
	:;<var>table</var>: a table (simple or extended, deponds on profile) containing the profile data to be saved		:;<var>table</var>: a table (simple or extended, deponds on profile) containing the profile data to be saved
	:;<var>del</var>: if set to '''1''' the passed table is deleted after saving		:;<var>del</var>: if set to '''1''' the passed table is deleted after saving

2018-03-02T15:01:27Z

← Older revision		Revision as of 17:01, 2 March 2018
Line 82:		Line 82:

	===Load a Profile===		===Load a Profile===
	;Usage: <code>$bstxini loadsetupelement <var>tag ; id ; tid ; subset</code>		;Usage: <code>$bstxini loadsetupelement <var>tag ; id ; tid ; subset</var></code>
	:;<var>tag</var>: the xml tag of the profile		:;<var>tag</var>: the xml tag of the profile
	:;<var>id</var>: the id of the profile		:;<var>id</var>: the id of the profile
Line 100:		Line 100:

	===Delete a profile===		===Delete a profile===
			;Usage: <code>$bstxini deletesetupelement <var>tag ; id ; <code>

	~~==Convert~~

	;~~usage~~: <code>$bstxini deletesetupelement <var>tag ; id ; <code>

	==Uncommon Functions and Functions for internal use only==		==Uncommon Functions and Functions for internal use only==

2018-03-02T15:00:18Z

2018-03-02T14:30:34Z

@@ Line 13: / Line 13: @@
-==BSTxIni Static Functions==
+==BSTXIni Static Functions==
 The following functions can be called without a BSTXINI instance.
@@ Line 49: / Line 49: @@
 :;<var>file</var>: the full path of the script file to be added; if the file is already in the history, it is moved to the top
-==BSTXIni Member Functions==
+===Get {{STx}} Version===
-The <code>BSTXIni</code> class has the following member functions. See BXMLDoc Member Functions for a list of functions implemented in the parent class.
+===Get Workspace File Path===
 ===DELETESETUPELEMENT tag ; id ; templateid ; ref===