$SirVer: Difference between revisions
(Automatically generated page update) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Current version number of Sirius product</span> | <span class="pageSubtitle">Current version number of Sirius product</span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SirVer function, but you can get the same information from the [[ | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SirVer function, but you can get the same information from the <var>[[SIRIUS command|SIRIUS]]</var> command.</p> | ||
This function returns the current version number of a particular Sirius product. | This function returns the current version number of a particular [[Sirius Software|Sirius]] product. | ||
The <var>$SirVer</var> function accepts one argument and returns a numeric result that is the current version number of the requested product. | The <var>$SirVer</var> function accepts one argument and returns a numeric result that is the current version number of the requested product. | ||
| Line 16: | Line 16: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">% | <p class="syntax"><span class="term">%ver</span> = <span class="literal">$SirVer</span>([<span class="term">product</span>]) | ||
</p> | </p> | ||
<p> | <p> | ||
< | <var class="term">%ver</var> is set to the current product version number.</p> | ||
< | |||
==Usage notes== | |||
This function can be used to ensure that you are running the correct version of the <var class="product">Sirius Mods</var> or of ''[[Fast/Unload]]''. For example, the program | This function can be used to ensure that you are running the correct version of the <var class="product">Sirius Mods</var> or of ''[[Fast/Unload]]''. For example, the program | ||
<p class="code"> IF $SirVer < 603 THEN | <p class="code">IF $SirVer < 603 THEN | ||
PRINT 'OBSOLETE SIRIUS FUNCTIONS' | |||
STOP | |||
END IF | |||
</p> | </p> | ||
| Line 44: | Line 45: | ||
<li>[[Japanese functions]]</li> | <li>[[Japanese functions]]</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$SirVer]] | [[Category:$Functions|$SirVer]] | ||
Revision as of 00:08, 16 April 2013
Current version number of Sirius product
Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SirVer function, but you can get the same information from the SIRIUS command.
This function returns the current version number of a particular Sirius product.
The $SirVer function accepts one argument and returns a numeric result that is the current version number of the requested product.
The argument is a string corresponding to one of the following products:
- SIRMODS: Sirius Mods
- FUNLOAD: Fast/Unload (accessed via the Fast/Unload User Language Interface)
Syntax
%ver = $SirVer([product])
%ver is set to the current product version number.
Usage notes
This function can be used to ensure that you are running the correct version of the Sirius Mods or of Fast/Unload. For example, the program
IF $SirVer < 603 THEN PRINT 'OBSOLETE SIRIUS FUNCTIONS' STOP END IF
would stop if the Sirius Mods were older than release 6.03.
The default product is SIRMODS, that is, if the argument is missing or is the null string, the version number of the Sirius Mods is returned. If the argument is invalid, 0 is returned. If the argument is FUNLOAD, and the Fast/Unload User Language Interface is not available, 0 is returned.