$SirProd: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:$SirProd}} <span class="pageSubtitle"><section begin="desc" />Determine availability of Sirius product or capability<section end="desc" /></span> <p class="warnin...")
 
m (misc cleanup)
 
(47 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:$SirProd}}
{{DISPLAYTITLE:$SirProd}}
<span class="pageSubtitle"><section begin="desc" />Determine availability of Sirius product or capability<section end="desc" /></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. The OO equivalent for the $SirProd function is [[to be entered]].</p>
<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 $SirProd 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.  


$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.  
<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 22: Line 36:
<li>12: Janus Specialty Data Store  
<li>12: Janus Specialty Data Store  
<li>13: Performance Enhancements  
<li>13: Performance Enhancements  
<li>14: Janus Web Server  
<li>14: <var class="product">Janus Web Server</var>
<li>15: Janus Network Security  
<li>15: Janus Network Security  
<li>16: Sir2000 User Language Tools  
<li>16: Sir2000 User Language Tools  
Line 40: Line 54:
<li>30: SirSafe  
<li>30: SirSafe  
<li>31: SirFact  
<li>31: SirFact  
<li>32: Janus Sockets  
<li>32: <var class="product">Janus Sockets</var>
<li>33: Performance Enhancements V3  
<li>33: Performance Enhancements V3  
<li>34: $SIR_LOGIN facility  
<li>34: $SIR_LOGIN facility  
<li>35: Janus SOAP  
<li>35: Janus SOAP  
<li>36: Fast/Forward  
<li>36: Fast/Forward  
<li>37: Limited Janus Web Server  
<li>37: <var class="product">Limited Janus Web Server</var>
<li>37: Reserved  
<li>37: Reserved  
<li>39: Janus Debugger  
<li>39: Janus Debugger  
<li>39: SirTune Data Collector  
<li>40: SirTune Data Collector  
<li>41: Sirius Debugger</ul>
<li>41: TN3270 Debugger</ul>
==Syntax==
<p class="syntax"><section begin="syntax" /> %AVAIL = $SirProd(product_code)
<section end="syntax" /></p>
<p class="caption">$SirProd Function
</p>
<p class="caption">%AVAIL is set to a non-zero number if the Sirius product or capability is available, or to 0 if it is not available.</p>


==Usage notes==
<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 SOUL 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:
<p class="code">IF $SirProd(5) = 0 THEN
<p class="code"> IF $SirProd(5) = 0 THEN
PRINT 'Fast/Unload is not available'
PRINT 'Fast/Unload is not available'
STOP
STOP
END IF
END IF
</p>
</p>
<blockquote> Prior to version 6.1, $SIRMOD always returned a value of 1 if the product or capability was available, but starting with version 6.1 it may return other non-zero values.</blockquote>
</ul>
 
==Products authorizing {{PAGENAMEE}}==
<ul class="smallAndTightList">
<ul class="smallAndTightList">
<li>[[Sirius functions]]</li>
<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>[[Japanese functions]]</li>
<li>Japanese functions</li>
<li>[[Sir2000 Field Migration Facility]]</li>
<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li>
 
</ul>
</ul>
<p class="caption">Products authorizing $SirProd
</p>


[[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

Products authorizing $SirProd

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$SirProd&oldid=81092"