$SirProd: Difference between revisions
(Automatically generated page update) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Determine availability of Sirius product or capability</span> | <span class="pageSubtitle">Determine availability of Sirius product or capability</span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SirProd function, though you can get a full list of local capabilities via the [[ | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SirProd function, though you can get a full list of local capabilities via the <var>[[SIRIUS command]]</var> command.</p> | ||
The <var>$SirProd</var> function checks to see if a particular Sirius product or capability is available. | The <var>$SirProd</var> function checks to see if a particular [[Sirius Software|Sirius]] product or capability is available. | ||
<var>$SirProd</var> accepts one argument and returns 1 if the argument is the code of a Sirius product or capability which is available in the current <var class="product">Model 204</var>, and 0 otherwise. | <var>$SirProd</var> accepts one argument and returns 1 if the argument is the code of a Sirius product or capability which is available in the current <var class="product">Model 204</var>, and 0 otherwise. | ||
| Line 57: | Line 57: | ||
where <var class="term">%AVAIL</var> is set to a non-zero number if the Sirius product or capability is available, or to 0 if it is not available. | where <var class="term">%AVAIL</var> is set to a non-zero number if the Sirius product or capability is available, or to 0 if it is not available. | ||
==Usage notes== | |||
This function can be used to ensure that a product is available. For example, the following program would stop if the ''[[Fast/Unload User Language Interface]]'' were not available: | This function can be used to ensure that a product is available. For example, the following program would stop if the ''[[Fast/Unload User Language Interface]]'' were not available: | ||
| Line 76: | Line 77: | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$SirProd]] | [[Category:$Functions|$SirProd]] | ||
Revision as of 00:03, 16 April 2013
Determine availability of Sirius product or capability
Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $SirProd function, though you can get a full list of local capabilities via the SIRIUS command command.
The $SirProd function checks to see if a particular Sirius product or capability is available.
$SirProd accepts one argument and returns 1 if the argument is the code of a Sirius product or capability which is available in the current Model 204, and 0 otherwise.
The argument is a number corresponding to the following products and capabilities:
- 1: Base User Language Functions
- 2: Fast/Reload
- 3: Fast/Reload FLOD Compiler
- 4: Fast/Backup
- 5: Fast/Unload Functions
- 6: Janus Base
- 7: Janus Open Server
- 8: Janus Open Client
- 9: Japanese Functions
- 10: SirScan
- 11: Trusted Login
- 12: Janus Specialty Data Store
- 13: Performance Enhancements
- 14: Janus Web Server
- 15: Janus Network Security
- 16: Sir2000 User Language Tools
- 17: Sir2000 Field Migration Facility
- 18: SirPro
- 19: SirFile
- 20: SirMon
- 21: SirXref
- 22: SirLib
- 23: SirDBA
- 24: Sirius Functions
- 25: SIRMSG Functions
- 26: Monitor Functions
- 27: Procedure Functions
- 28: Library Functions
- 29: Performance Enhancements V2
- 30: SirSafe
- 31: SirFact
- 32: Janus Sockets
- 33: Performance Enhancements V3
- 34: $SIR_LOGIN facility
- 35: Janus SOAP
- 36: Fast/Forward
- 37: Limited Janus Web Server
- 37: Reserved
- 39: Janus Debugger
- 40: SirTune Data Collector
- 41: Sirius Debugger
Syntax
%AVAIL = $SirProd(product_code)
where %AVAIL is set to a non-zero number if the Sirius product or capability is available, or to 0 if it is not available.
Usage notes
This function can be used to ensure that a product is available. For example, the following program would stop if the Fast/Unload User Language Interface were not available:
IF $SirProd(5) = 0 THEN PRINT 'Fast/Unload is not available' STOP END IF