Difference between revisions of "Programmer Guide/Macro Library/BXMLDoc/SelectIRef"

From STX Wiki
Jump to navigation Jump to search
(Created page with ";<code><var>bxmldoc</var> SelectIRef [ <var>pos</var>=* ; <var>in</var>=0 ]</code>: :;<var>pos</var>: An (unique internal) element reference, a xml-position or the character <...")
 
Line 3: Line 3:
 
:;<var>in</var>: Go into the selected element (<code>1</code>) or not (<code>0</code>).
 
:;<var>in</var>: Go into the selected element (<code>1</code>) or not (<code>0</code>).
 
;Result: 0 for success or an errorcode
 
;Result: 0 for success or an errorcode
;Description: Selects the element referred to by <var>pos</var>. A reference a file item position string, an internal XML reference or the value * (= current element) can be used. If the element is selected successful and <var>in</var> equals <code>1</code> the child element level of the element is selected. You can create an IRef for an element with the member function <code>FormatIRef</code>.
+
;Description: Selects the element referred to by <var>pos</var>. A reference a file item position string, an internal XML reference or the value * (= current element) can be used. If the element is selected successful and <var>in</var> equals <code>1</code> the child element level of the element is selected. You can create an IRef for an element with the member function <code>[[Programmer_Guide/Macro_Library/BXMLDoc#FormatIRef|FormatIRef]]</code>.
 
;see also: commands [[Programmer_Guide/Command_Reference/IREF|IREF]] and [[Programmer_Guide/Command_Reference/POSITION|POSITION]]
 
;see also: commands [[Programmer_Guide/Command_Reference/IREF|IREF]] and [[Programmer_Guide/Command_Reference/POSITION|POSITION]]

Revision as of 10:26, 1 October 2019

bxmldoc SelectIRef [ pos=* ; in=0 ]
pos
An (unique internal) element reference, a xml-position or the character * for the current element.
in
Go into the selected element (1) or not (0).
Result
0 for success or an errorcode
Description
Selects the element referred to by pos. A reference a file item position string, an internal XML reference or the value * (= current element) can be used. If the element is selected successful and in equals 1 the child element level of the element is selected. You can create an IRef for an element with the member function FormatIRef.
see also
commands IREF and POSITION