$SirVer: Difference between revisions
m (1 revision) |
mNo edit summary |
||
Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Current version number of Sirius product<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Current version number of Sirius product<section end="desc" /></span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. | <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 [[Sirius 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 product. | ||
Line 9: | Line 9: | ||
The argument is a string corresponding to one of the following products: | The argument is a string corresponding to one of the following products: | ||
<ul> | <ul> | ||
<li>SIRMODS: ''[[Sirius Mods]]'' | <li>SIRMODS: ''[[Sirius Mods]]'' | ||
<li>FUNLOAD: ''[[Fast/Unload]]'' (accessed via the ''[[Fast/Unload User Language Interface]]'') | <li>FUNLOAD: ''[[Fast/Unload]]'' (accessed via the ''[[Fast/Unload User Language Interface]]'') | ||
Line 22: | Line 22: | ||
<p class="caption">%VER is set to the current product version number.</p> | <p class="caption">%VER is set to the current product version number.</p> | ||
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 | |||
<p class="code"> IF $SirVer < 203 THEN | <p class="code"> IF $SirVer < 203 THEN | ||
PRINT 'OBSOLETE SIRIUS FUNCTIONS' | PRINT 'OBSOLETE SIRIUS FUNCTIONS' | ||
Line 29: | Line 29: | ||
END IF | END IF | ||
</p> | </p> | ||
would stop if the ''[[Sirius Mods]]'' were older than release 2.03. | would stop if the ''[[Sirius Mods]]'' were older than release 2.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. | 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. | ||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
Line 47: | Line 47: | ||
<p class="caption">Products authorizing $SirVer | <p class="caption">Products authorizing $SirVer | ||
</p> | </p> | ||
[[Category:$Functions|$SirVer]] | [[Category:$Functions|$SirVer]] |
Revision as of 18:54, 8 February 2011
<section begin="desc" />Current version number of Sirius product<section end="desc" />
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
<section begin="syntax" /> %VER = $SirVer(product) <section end="syntax" />
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 < 203 THEN PRINT 'OBSOLETE SIRIUS FUNCTIONS' STOP END IF
would stop if the Sirius Mods were older than release 2.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.