$Bump - Revision history

DCameron at 13:09, 7 November 2018

2018-11-07T13:09:35Z

← Older revision		Revision as of 13:09, 7 November 2018
Line 39:		Line 39:
	END		END
	</p>		</p>

			==Products authorizing {{PAGENAMEE}}==
			<ul class="smallAndTightList">
			<li>[[SirMon\|SirMon]]</li>

			</ul>
			<p>
			</p>


	[[Category:$Functions\|$Bump]]		[[Category:$Functions\|$Bump]]

JAL: misc formatting

2018-01-16T17:26:56Z

misc formatting

← Older revision		Revision as of 17:26, 16 January 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Bump a user</span>		<span class="pageSubtitle">Bump a user</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. There is ~~currrently~~ no OO equivalent for the $Bump function as ~~we have yet to implement a~~ User ~~Class~~.</p>		<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the <var>$Bump</var> function as no User class is implemented.</p>

	The <var>$Bump</var> function allows a privileged user (system manager or system administrator) to bump another user as ~~with~~ the <var>[[~~BUMP_command~~\|BUMP]]</var> command.		The <var>$Bump</var> function allows a privileged user (system manager or system administrator) to bump another user just as the <var>[[BUMP command\|BUMP]]</var> command does.

	<var>$Bump</var> accepts one or two arguments and returns a numeric code.		<var>$Bump</var> accepts one or two arguments and returns a numeric code.

	~~The first argument is the number of the user to be bumped.~~

	The second argument is an optional <var>[[USERID_parameter\|userid]]</var>. If this argument is provided, the user number indicated by argument one will only be bumped if the userid matches the second argument. This helps prevent accidentally bumping a user that just logged onto a thread previously occupied by another user.

	==Syntax==		==Syntax==
Line 16:		Line 12:
	</p>		</p>

	<p>		<table>
	<var class="term">~~%result~~</var> is ~~set to indicate~~ the ~~success of the function~~.</p>		<tr><th>%result</th>
			<td>A numeric value (see [[#Return codes\|Return codes]]) that indicates the success of the function.</td></tr>

			<tr><th>user_num</th>
			<td>The number of the user to be bumped. </td></tr>

			<tr><th>userid</th>
			<td>An optional [[USERID parameter\|user ID]]. If this argument is provided, the user indicated by <var class="term">user_num</var> is bumped only if the user ID matches <var class="term">userid</var>. This helps prevent accidentally bumping a user that just logged onto a thread previously occupied by another user. </td></tr>
			</table>

	===Return codes===		===Return codes===
Line 26:		Line 30:

	==Usage notes==		==Usage notes==
	The behavior of <var>$Bump</var> is affected by the <var>[[FUNCOPTS parameter\|FUNCOPTS]]</var> system parameter: If the FUNCOPTS X'01' bit is set, a caller of <var>$Bump</var> can bump any thread that has the same user ID as that of the caller, whether or not the caller is a system administrator or system manager.		The behavior of <var>$Bump</var> is affected by the <var>[[FUNCOPTS parameter\|FUNCOPTS]]</var> system parameter: If the <var>FUNCOPTS</var> X'01' bit is set, a caller of <var>$Bump</var> can bump any thread that has the same user ID as that of the caller, whether or not the caller is a system administrator or system manager.

	==Example==		==Example==
	The following program bumps ~~userid '~~HOMER~~' with~~ user number 13.		The following program bumps user ID <code>HOMER</code> that has user number 13:

	<p class="code">B		<p class="code">B

DCameron at 12:27, 16 January 2018

2018-01-16T12:27:52Z

← Older revision		Revision as of 12:27, 16 January 2018
Line 10:		Line 10:
	The first argument is the number of the user to be bumped.		The first argument is the number of the user to be bumped.

	The second argument is an optional userid. If this argument is provided, the user number indicated by argument one will only be bumped if the userid matches the second argument. This helps prevent accidentally bumping a user that just logged onto a thread previously occupied by another user.		The second argument is an optional <var>[[USERID_parameter\|userid]]</var>. If this argument is provided, the user number indicated by argument one will only be bumped if the userid matches the second argument. This helps prevent accidentally bumping a user that just logged onto a thread previously occupied by another user.

	==Syntax==		==Syntax==

DCameron at 12:25, 16 January 2018

2018-01-16T12:25:16Z

← Older revision		Revision as of 12:25, 16 January 2018
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currrently no OO equivalent for the $Bump function as we have yet to implement a User Class.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currrently no OO equivalent for the $Bump function as we have yet to implement a User Class.</p>

	The <var>$Bump</var> function allows a privileged user (~~[[Category:System_manager_commands\|~~system manager]] or system administrator) to bump another user as with the <var>[[BUMP_command\|BUMP]]</var> command.		The <var>$Bump</var> function allows a privileged user (system manager or system administrator) to bump another user as with the <var>[[BUMP_command\|BUMP]]</var> command.

	<var>$Bump</var> accepts one or two arguments and returns a numeric code.		<var>$Bump</var> accepts one or two arguments and returns a numeric code.

DCameron at 12:24, 16 January 2018

2018-01-16T12:24:29Z

← Older revision		Revision as of 12:24, 16 January 2018
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currrently no OO equivalent for the $Bump function as we have yet to implement a User Class.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currrently no OO equivalent for the $Bump function as we have yet to implement a User Class.</p>

	The <var>$Bump</var> function allows a privileged user (system manager or system administrator) to bump another user as with the <var>[[BUMP_command\|BUMP]]</var> command.		The <var>$Bump</var> function allows a privileged user ([[Category:System_manager_commands\|system manager]] or system administrator) to bump another user as with the <var>[[BUMP_command\|BUMP]]</var> command.

	<var>$Bump</var> accepts one or two arguments and returns a numeric code.		<var>$Bump</var> accepts one or two arguments and returns a numeric code.

DCameron at 12:20, 16 January 2018

2018-01-16T12:20:43Z

← Older revision		Revision as of 12:20, 16 January 2018
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currrently no OO equivalent for the $Bump function as we have yet to implement a User Class.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currrently no OO equivalent for the $Bump function as we have yet to implement a User Class.</p>

	The <var>$Bump</var> function allows a privileged user (system manager or system administrator) to bump another user as with the BUMP command.		The <var>$Bump</var> function allows a privileged user (system manager or system administrator) to bump another user as with the <var>[[BUMP_command\|BUMP]]</var> command.

	<var>$Bump</var> accepts one or two arguments and returns a numeric code.		<var>$Bump</var> accepts one or two arguments and returns a numeric code.

ELowell: /* Usage notes */

2017-02-23T20:22:35Z

Usage notes

← Older revision		Revision as of 20:22, 23 February 2017
Line 26:		Line 26:

	==Usage notes==		==Usage notes==
	The behavior of <var>$Bump</var> is affected by the FUNCOPTS system parameter: If the FUNCOPTS X'01' bit is set, a caller of <var>$Bump</var> can bump any thread that has the same user ID as that of the caller, whether or not the caller is a system administrator or system manager.		The behavior of <var>$Bump</var> is affected by the <var>[[FUNCOPTS parameter\|FUNCOPTS]]</var> system parameter: If the FUNCOPTS X'01' bit is set, a caller of <var>$Bump</var> can bump any thread that has the same user ID as that of the caller, whether or not the caller is a system administrator or system manager.

	==Example==		==Example==

JAL at 17:57, 30 August 2013

2013-08-30T17:57:51Z

← Older revision		Revision as of 17:57, 30 August 2013
Line 11:		Line 11:

	The second argument is an optional userid. If this argument is provided, the user number indicated by argument one will only be bumped if the userid matches the second argument. This helps prevent accidentally bumping a user that just logged onto a thread previously occupied by another user.		The second argument is an optional userid. If this argument is provided, the user number indicated by argument one will only be bumped if the userid matches the second argument. This helps prevent accidentally bumping a user that just logged onto a thread previously occupied by another user.

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$Bump</span>(<span class="term">user_num</span>, [<span class="term">userid</span>])		<p class="syntax"><span class="term">%result</span> = <span class="literal">$Bump</span>(<span class="term">user_num</span>, [<span class="term">userid</span>])
Line 18:		Line 19:
	<var class="term">%result</var> is set to indicate the success of the function.</p>		<var class="term">%result</var> is set to indicate the success of the function.</p>

			===Return codes===
			<p class="code">0 - User bumped
			1 - User not found
			2 - Not privileged to issue BUMP command
			</p>

			==Usage notes==
	The behavior of <var>$Bump</var> is affected by the FUNCOPTS system parameter: If the FUNCOPTS X'01' bit is set, a caller of <var>$Bump</var> can bump any thread that has the same user ID as that of the caller, whether or not the caller is a system administrator or system manager.		The behavior of <var>$Bump</var> is affected by the FUNCOPTS system parameter: If the FUNCOPTS X'01' bit is set, a caller of <var>$Bump</var> can bump any thread that has the same user ID as that of the caller, whether or not the caller is a system administrator or system manager.

	~~<p class="code"> 0 - User bumped~~
	~~1 - User not found~~
	~~2 - Not privileged to issue BUMP command~~
	~~</p>~~
	~~<p class="caption">$Bump return codes~~
	~~</p>~~

	==Example==		==Example==
Line 34:		Line 35:
	END		END
	</p>		</p>
	~~<p class="code">~~

	[[Category:$Functions\|$Bump]]		[[Category:$Functions\|$Bump]]

JAL at 17:53, 30 August 2013

2013-08-30T17:53:08Z

← Older revision		Revision as of 17:53, 30 August 2013
Line 1:		Line 1:
	~~{{DISPLAYTITLE:$Bump}}~~
	<span class="pageSubtitle">Bump a user</span>		<span class="pageSubtitle">Bump a user</span>

JALWiccan: Automatically generated page update

2013-07-18T20:25:41Z

Automatically generated page update

← Older revision		Revision as of 20:25, 18 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Bump a user</span>		<span class="pageSubtitle">Bump a user</span>

	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currrently no OO equivalent for the $Bump function as we have yet to implement a User Class.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currrently no OO equivalent for the $Bump function as we have yet to implement a User Class.</p>

	The <var>$Bump</var> function allows a privileged user (system manager or system administrator) to bump another user as with the BUMP command.		The <var>$Bump</var> function allows a privileged user (system manager or system administrator) to bump another user as with the BUMP command.