$Priorty: Difference between revisions
m (1 revision) |
(Automatically generated page update) |
||
| (25 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$Priorty}} | {{DISPLAYTITLE:$Priorty}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Change a user's priority</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 $Priorty function.</p> | ||
The $Priorty function allows a privileged user (system manager or system administrator) to change another user's priority. | The <var>$Priorty</var> function allows a privileged user (system manager or system administrator) to change another user's priority. | ||
''Note: As of [[Sirius Mods]] Version 7.3, you can open access to $Priorty beyond system managers or system administrators by specifying the FUNCOPTS system parameter X'40' or X'20' bit settings | '''Note:''' As of <var class="product">[[Sirius Mods]]</var> Version 7.3, you can open access to <var>$Priorty</var> beyond system managers or system administrators by specifying the <var>[[FUNCOPTS parameter|FUNCOPTS]]</var> system parameter X'40' or X'20' bit settings. | ||
The $Priorty function accepts four arguments and returns a numeric code. | The <var>$Priorty</var> function accepts four arguments and returns a numeric code. | ||
The first argument is the number of the user whose priority is to be changed. | The first argument is the number of the user whose priority is to be changed. | ||
| Line 19: | Line 19: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">< | <p class="syntax"><span class="term">%result </span><span class="literal">= $Priorty ( </span><span class="term">user_num</span>, [<span class="term">userid</span>], <span class="term">min</span>, [<span class="term">max</span>]<span class="literal">)</span> | ||
< | |||
< | |||
</p> | </p> | ||
<p class="code"> | Where <var class="term">%result</var> is set to indicate the success of the function. | ||
===Return codes=== | |||
<p class="code">0 - Priority changed | |||
1 - User not found | |||
2 - Not privileged to issue PRIORITY command | |||
3 - Invalid priority specified | |||
</p> | </p> | ||
$Priorty gives you more flexibility in the priorities you can assign to a user than does the PRIORITY command. The valid priorities with the PRIORITY command and their corresponding minimum and maximum priority values are | ==Usage notes== | ||
<ul> | |||
<li><var>$Priorty</var> gives you more flexibility in the priorities you can assign to a user than does the <var>PRIORITY</var> command. The valid priorities with the <var>PRIORITY</var> command and their corresponding minimum and maximum priority values are: | |||
< | <table> | ||
< | <tr><th><var>LOW</var></th><td>0 and 47</td></tr> | ||
< | <tr><th><var>STANDARD</var></th><td>32 and 79</td></tr> | ||
< | <tr><th><var>HIGH</var></th><td>80 and 127</td></tr> | ||
</ | </table> | ||
The current priority of a user whose priority is reset via $Priorty is set to | <li>The current priority of a user whose priority is reset via <var>$Priorty</var> is set to | ||
<p class="code"> ( ( 2 * min_priority ) + max_priority ) / 3 | <p class="code">( ( 2 * min_priority ) + max_priority ) / 3 | ||
</p> | </p> | ||
</ul> | |||
The following program sets user 0 to low priority. | ==Example== | ||
<p class="code"> B | The following program sets user 0 to low priority.<p class="code">B | ||
%rc = $priorty( 0, , 0) | |||
End | |||
</p> | </p> | ||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]] | <li>[[List of $functions|Sirius functions]] | ||
</ul> | </ul> | ||
[[Category:$Functions|$Priorty]] | [[Category:$Functions|$Priorty]] | ||
Latest revision as of 22:52, 20 September 2018
Change a user's priority
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Priorty function.
The $Priorty function allows a privileged user (system manager or system administrator) to change another user's priority.
Note: As of Sirius Mods Version 7.3, you can open access to $Priorty beyond system managers or system administrators by specifying the FUNCOPTS system parameter X'40' or X'20' bit settings.
The $Priorty function accepts four arguments and returns a numeric code.
The first argument is the number of the user whose priority is to be changed.
The second argument is an optional userid. If this argument is provided, the user number indicated by argument one will only have its priority changed if the userid matches the second argument. This prevents accidentally changing the priority of a user that just logged onto a thread previously occupied by another user.
The third argument is a number indicating the user's new minimum priority. This is a required argument and must be between 0 and 111.
The fourth argument is a number indicating the user's new maximum priority. This is an optional argument and must be between the minimum priority (argument 3) plus 16 and 127. The default for this argument is the minimum priority plus 47.
Syntax
%result = $Priorty ( user_num, [userid], min, [max])
Where %result is set to indicate the success of the function.
Return codes
0 - Priority changed 1 - User not found 2 - Not privileged to issue PRIORITY command 3 - Invalid priority specified
Usage notes
- $Priorty gives you more flexibility in the priorities you can assign to a user than does the PRIORITY command. The valid priorities with the PRIORITY command and their corresponding minimum and maximum priority values are:
LOW 0 and 47 STANDARD 32 and 79 HIGH 80 and 127 - The current priority of a user whose priority is reset via $Priorty is set to
( ( 2 * min_priority ) + max_priority ) / 3
Example
The following program sets user 0 to low priority.
B %rc = $priorty( 0, , 0) End