$Random Seed: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 30: | Line 30: | ||
==Products authorizing $Random_Seed== | ==Products authorizing $Random_Seed== | ||
<ul class="smallAndTightList"> | <h2>Products authorizing {{PAGENAMEE}}</h2><ul class="smallAndTightList"> | ||
<li>[[Sirius functions]]</li> | <li>[[Sirius functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
Revision as of 18:31, 25 October 2012
Build seed specifying series of $RANDOM results
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Random_Seed function is the RandomNumberGenerator class.
This function sets a %variable or IMAGE item to a value that can be used by $Random, so that the series of numbers returned by $Random is reproducible.
$Random_Seed accepts two required arguments and returns zero.
Syntax
<section begin="syntax" />%result = $Random_Seed(%seed, seed_value) <section end="syntax" />
Syntax terms
| %result | A zero, which indicates success.
If any argument is invalid or omitted, the request is cancelled. |
|---|---|
| %seed | A %variable or IMAGE item to be set to a random number seed. This argument must be a string of length at least 144. %seed is initialized for a series of $Random results that depends on seed_value. |
| seed_value | A number that determines the $Random series. This argument must be greater than or equal to -1,000,000,000 and less than or equal to 1,000,000,000. |
Examples
See the description of $Random for examples of the use of $Random_Seed.