SetObject (Subsystem function) - Revision history

JAL: move nowiki tag

2015-02-19T23:52:39Z

move nowiki tag

← Older revision		Revision as of 23:52, 19 February 2015
Line 26:		Line 26:
	==Examples==		==Examples==
	The following example shows how the generation number can be used to make sure that you do not update an object that someone else updated after you got your copy.		The following example shows how the generation number can be used to make sure that you do not update an object that someone else updated after you got your copy.
	<p class="code"~~><nowiki~~>%myObj is object myClass		<p class="code">%myObj is object myClass
	...		...
	retry:		retry:
	%gen = %(system):~~</nowiki>~~[[GetObject_(Subsystem_function)\|getObject]]~~<nowiki>~~('FOO', %myObj)		%gen = %(system):[[GetObject_(Subsystem_function)\|getObject]]('FOO', %myObj)
	... fiddle with the object		... fiddle with the object
	* Now try to update it		<nowiki>* Now try to update it
	if not %(system):setObject('FOO', %myObj, %gen) then		if not %(system):setObject('FOO', %myObj, %gen) then
	* Someone else changed it, let's see what they did		* Someone else changed it, let's see what they did

JALWiccan: Automatically generated page update

2014-02-16T00:31:08Z

Automatically generated page update

← Older revision		Revision as of 00:31, 16 February 2014
Line 11:		Line 11:
	<p>All other errors result in request cancellation.</p></td></tr>		<p>All other errors result in request cancellation.</p></td></tr>

	<tr><th><var>%(Subsystem)</var></th>		<tr><th><var class="nobr">%(Subsystem)</var></th>
	<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods\|shared]] method. <var>SetObject</var> can also be invoked via a <var>Subsystem</var> object variable, which may be <var>null</var>.</td></tr>		<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods\|shared]] method. <var>SetObject</var> can also be invoked via a <var>Subsystem</var> object variable, which may be <var>null</var>.</td></tr>

JAL at 21:41, 16 November 2012

2012-11-16T21:41:37Z

← Older revision		Revision as of 21:41, 16 November 2012
Line 1:		Line 1:
	{{Template:Subsystem:SetObject subtitle}}		{{Template:Subsystem:SetObject subtitle}}
	The <var>SetObject</var> method makes a given object available with a specified name to the ~~Online or~~ <var>~~[[Subsystem_class\|~~Subsystem]]</var>. An object made thus available is known as a [[Subsystem_class#System-wide_objects\|"system-wide object"]].		The <var>SetObject</var> method makes a given object available with a specified name to the subsystem identified by the <var>Subsystem</var> method object. An object made thus available is known as a [[Subsystem_class#System-wide_objects\|"system-wide object"]].

	==Syntax==		==Syntax==
	{{Template:Subsystem:SetObject syntax}}		{{Template:Subsystem:SetObject syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%gen</th><td>The new generation number associated with name. This is a positive integer (set to 1 the first time the method succeeds) that increases by one each time the name object is updated. <var class="term">gen</var> is set to 0 if the method encounters a problem or if <var class="term">testGen</var> differs from the current generation number of name.		<tr><th>%gen</th>
			<td>The new generation number associated with name. This is a positive integer (set to 1 the first time the method succeeds) that increases by one each time the name object is updated. <var class="term">gen</var> is set to 0 if the method encounters a problem or if <var class="term">testGen</var> differs from the current generation number of name.
	<p>All other errors result in request cancellation.</p></td></tr>		<p>All other errors result in request cancellation.</p></td></tr>

	<tr><th><var>%(Subsystem)</var></th>		<tr><th><var>%(Subsystem)</var></th>
	<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods\|shared]] method. <var>SetObject</var> can also be invoked via a <var>~~[[Subsystem_class\|~~Subsystem]]</var> object variable, which may be <var>null</var>.</td></tr>		<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods\|shared]] method. <var>SetObject</var> can also be invoked via a <var>Subsystem</var> object variable, which may be <var>null</var>.</td></tr>

	<tr><th>name</th>		<tr><th>name</th>
	<td>The string name by which the system-wide object is identified.</td></tr>		<td>The string name by which the system-wide object is identified.</td></tr>

	<tr><th>object</th>		<tr><th>object</th>
	<td>The object variable that becomes the current system-wide object. The object referenced by <var class="term">object</var> must be [[Copying objects\|"deep copyable"]]).</td></tr>		<td>The object variable that becomes the current system-wide object. The object referenced by <var class="term">object</var> must be [[Copying objects\|"deep copyable"]].</td></tr>

	<tr><th>testGen</th>		<tr><th>testGen</th>
	<td>An optional argument, this is an integer that is compared to the current generation number of name. If the values differ, <var>SetObject</var> fails to replace <var class="term">~~%obj~~</var>, and it returns a 0 value.</td></tr>		<td>An optional argument, this is an integer that is compared to the current generation number of name. If the values differ, <var>SetObject</var> fails to replace <var class="term">object</var>, and it returns a 0 value.</td></tr>
	</table>		</table>

Line 31:		Line 37:
	end if		end if
	</nowiki></p>		</nowiki></p>
	In this case, when you try to update FOO, FOO's generation is compared with %gen. If the generation number changed, the <var>SetObject</var> call does not succeed, and 0 is returned.		In this case, when you try to update <code>FOO</code>, <code>FOO</code>'s generation is compared with <code>%gen</code>. If the generation number changed, the <var>SetObject</var> call does not succeed, and 0 is returned.

	==See also==		==See also==
	{{Template:Subsystem:SetObject footer}}		{{Template:Subsystem:SetObject footer}}

JALWiccan: 1 revision

2011-11-30T18:28:23Z

1 revision

← Older revision	Revision as of 18:28, 30 November 2011
(No difference)

JALWiccan: 1 revision

2011-11-30T18:28:21Z

1 revision

← Older revision		Revision as of 18:28, 30 November 2011
Line 9:		Line 9:
	<p>All other errors result in request cancellation.</p></td></tr>		<p>All other errors result in request cancellation.</p></td></tr>
	<tr><th><var>%(Subsystem)</var></th>		<tr><th><var>%(Subsystem)</var></th>
	<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods ~~and constructors~~\|shared]] method. <var>SetObject</var> can also be invoked via a <var>[[Subsystem_class\|Subsystem]]</var> object variable, which may be <var>null</var>.</td></tr>		<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods\|shared]] method. <var>SetObject</var> can also be invoked via a <var>[[Subsystem_class\|Subsystem]]</var> object variable, which may be <var>null</var>.</td></tr>
	<tr><th>name</th>		<tr><th>name</th>
	<td>The string name by which the system-wide object is identified.</td></tr>		<td>The string name by which the system-wide object is identified.</td></tr>

JALWiccan: 1 revision

2011-07-14T17:56:53Z

1 revision

← Older revision	Revision as of 17:56, 14 July 2011
(No difference)

JALWiccan: 1 revision

2011-07-14T17:56:52Z

1 revision

← Older revision		Revision as of 17:56, 14 July 2011
Line 9:		Line 9:
	<p>All other errors result in request cancellation.</p></td></tr>		<p>All other errors result in request cancellation.</p></td></tr>
	<tr><th><var>%(Subsystem)</var></th>		<tr><th><var>%(Subsystem)</var></th>
	<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods\|shared]] method. <var>SetObject</var> can also be invoked via a <var>[[Subsystem_class\|Subsystem]]</var> object variable, which may be <var>null</var>.</td></tr>		<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods and constructors\|shared]] method. <var>SetObject</var> can also be invoked via a <var>[[Subsystem_class\|Subsystem]]</var> object variable, which may be <var>null</var>.</td></tr>
	<tr><th>name</th>		<tr><th>name</th>
	<td>The string name by which the system-wide object is identified.</td></tr>		<td>The string name by which the system-wide object is identified.</td></tr>

JALWiccan: 1 revision

2011-07-01T21:20:39Z

1 revision

← Older revision	Revision as of 21:20, 1 July 2011
(No difference)

JALWiccan: 1 revision

2011-07-01T21:20:37Z

1 revision

← Older revision		Revision as of 21:20, 1 July 2011
Line 9:		Line 9:
	<p>All other errors result in request cancellation.</p></td></tr>		<p>All other errors result in request cancellation.</p></td></tr>
	<tr><th><var>%(Subsystem)</var></th>		<tr><th><var>%(Subsystem)</var></th>
	<td>The class name in parentheses denotes a ~~ÝÝNotation~~ conventions for methods#Shared methods\|shared]] method. <var>SetObject</var> can also be invoked via a <var>[[Subsystem_class\|Subsystem]]</var> object variable, which may be <var>null</var>.</td></tr>		<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods\|shared]] method. <var>SetObject</var> can also be invoked via a <var>[[Subsystem_class\|Subsystem]]</var> object variable, which may be <var>null</var>.</td></tr>
	<tr><th>name</th>		<tr><th>name</th>
	<td>The string name by which the system-wide object is identified.</td></tr>		<td>The string name by which the system-wide object is identified.</td></tr>

JALWiccan: 1 revision

2011-07-01T21:19:05Z

1 revision

← Older revision	Revision as of 21:19, 1 July 2011
(No difference)