$SirProd: Difference between revisions
Jump to navigation
Jump to search
m (→Syntax) |
m (misc cleanup) |
||
| (23 intermediate revisions by 5 users not shown) | |||
| 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=" | <p class="warn"><b>Note: </b>Many $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|SIRIUS]]</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. | ||
==Syntax== | |||
<p class="syntax"><span class="term">%avail</span> = <span class="literal">$SirProd</span>(<span class="term">product_code</span>) | |||
</p> | |||
===Syntax terms=== | |||
<table> | |||
<tr><th>%avail</th> | |||
<td>A numeric variable set to a non-zero number (if the Sirius product or capability is available) or set to 0 (if the product or capability is not available).</td></tr> | |||
<tr><th>product_code</th> | |||
<td>A number corresponding to the products and capabilities shown in [[#Product codes|Product codes]], below.</td></tr> | |||
</table> | |||
===Product codes=== | |||
<ul> | |||
<li> 1: Base User Language Functions | <li> 1: Base User Language Functions | ||
<li> 2: Fast/Reload | <li> 2: Fast/Reload | ||
| Line 49: | Line 63: | ||
<li>39: Janus Debugger | <li>39: Janus Debugger | ||
<li>40: SirTune Data Collector | <li>40: SirTune Data Collector | ||
<li>41: | <li>41: TN3270 Debugger</ul> | ||
==Usage notes== | |||
<ul> | |||
This function can be used to ensure that a product is available. For example, the following program would stop if the | <li>This function can be used to ensure that a product is available. For example, the following program would stop if the [[Fast/Unload SOUL Interface]] were not available: | ||
<p class="code">IF $SirProd(5) = 0 THEN | <p class="code">IF $SirProd(5) = 0 THEN | ||
| Line 64: | Line 74: | ||
END IF | END IF | ||
</p> | </p> | ||
</ul> | |||
==Products authorizing {{PAGENAMEE}}== | |||
<li>[[Sirius functions]]</li> | <ul class="smallAndTightList"> | ||
<li>[[List of $functions|Sirius functions]]</li> | |||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[Janus Open Server]]</li> | <li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li> | ||
<li>[[Janus Sockets]]</li> | <li>[[Janus Sockets]]</li> | ||
<li>[[Janus Web Server]]</li> | <li>[[Janus Web Server]]</li> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$SirProd]] | [[Category:$Functions|$SirProd]] | ||
Latest revision as of 23:28, 6 October 2015
Determine availability of Sirius product or capability
Note: Many $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.
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.
Syntax
%avail = $SirProd(product_code)
Syntax terms
| %avail | A numeric variable set to a non-zero number (if the Sirius product or capability is available) or set to 0 (if the product or capability is not available). |
|---|---|
| product_code | A number corresponding to the products and capabilities shown in Product codes, below. |
Product codes
- 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: TN3270 Debugger
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 SOUL Interface were not available:
IF $SirProd(5) = 0 THEN PRINT 'Fast/Unload is not available' STOP END IF