$SirProd: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(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="warn"><b>Note: </b>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>
<p class="warn"><b>Note: </b>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|SIRIUS]]</var> command.</p>


The <var>$SirProd</var> function checks to see if a particular [[Sirius Software|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.  
Line 8: Line 8:
<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.  


The argument is a number corresponding to the following products and capabilities:<ul>  
==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 50: Line 62:
<li>40: SirTune Data Collector  
<li>40: SirTune Data Collector  
<li>41: Sirius Debugger</ul>
<li>41: Sirius Debugger</ul>
==Syntax==
<p class="syntax"><span class="term">%AVAIL</span> = <span class="literal">$SirProd</span>(<span class="term">product_code</span>)
</p>
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==
==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:
<ul>
<li>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:


<p class="code">IF $SirProd(5) = 0 THEN
<p class="code">IF $SirProd(5) = 0 THEN
Line 65: Line 71:
END IF
END IF
</p>
</p>
</ul>


==Products authorizing {{PAGENAMEE}}==  
==Products authorizing {{PAGENAMEE}}==  

Revision as of 22:28, 19 July 2013

Determine availability of Sirius product or capability

Note: 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.

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: Sirius 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 User Language Interface were not available:

    IF $SirProd(5) = 0 THEN PRINT 'Fast/Unload is not available' STOP END IF

Products authorizing $SirProd