Studio:AutoScript Functions - Revision history

Timd at 16:08, 21 August 2009

2009-08-21T16:08:22Z

← Older revision		Revision as of 16:08, 21 August 2009
Line 113:		Line 113:


	[[Category: AutoScript]]		[[Category:Studio:AutoScript]]

Timd: moved AutoScript Functions to Studio:AutoScript Functions

2009-08-21T16:07:41Z

moved AutoScript Functions to Studio:AutoScript Functions

← Older revision	Revision as of 16:07, 21 August 2009
(No difference)

Ivailop: /* Asynchronous Calls (non-blocking) */

2008-12-12T00:34:27Z

Asynchronous Calls (non-blocking)

← Older revision		Revision as of 00:34, 12 December 2008
Line 64:		Line 64:
	* Current values of all fields of the ParameterList property are marshaled to the called function.		* Current values of all fields of the ParameterList property are marshaled to the called function.
	* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using [[AutoScript_Events#WaitForEvent\|ascript.WaitForEvent()]].		* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using [[AutoScript_Events#WaitForEvent\|ascript.WaitForEvent()]].
	* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown.
	* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:		* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:
	{\| cellspacing="0" cellpadding="1" width="100%" border="0"		{\| cellspacing="0" cellpadding="1" width="100%" border="0"
Line 83:		Line 82:
	* The current values of all fields in the ParameterList property are marshaled to the called function.		* The current values of all fields in the ParameterList property are marshaled to the called function.
	* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using ascript.WaitForEvent().		* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using ascript.WaitForEvent().
	* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown.
	* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:		* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:
	{\| cellspacing="0" cellpadding="1" width="100%" border="0"		{\| cellspacing="0" cellpadding="1" width="100%" border="0"

Ivailop: /* CallBypassOverride */

2008-12-12T00:30:04Z

CallBypassOverride

← Older revision		Revision as of 00:30, 12 December 2008
Line 109:		Line 109:
	* If there is no registered owner or registered override owner, an exception is thrown.		* If there is no registered owner or registered override owner, an exception is thrown.
	* If there is no registered owner but there is a registered override owner, the call is routed to the registered override owner.		* If there is no registered owner but there is a registered override owner, the call is routed to the registered override owner.
	* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown~~. For interactively run scripts the timeout behavior differ; see [[AutoScript Timeout Considerations\|Timeout Considerations]]~~.		* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown.

	=== Returns ===		=== Returns ===

Ivailop: /* Call */

2008-12-12T00:29:49Z

Call

← Older revision		Revision as of 00:29, 12 December 2008
Line 101:		Line 101:
	* If there is no registered owner or registered override owner, an exception is thrown.		* If there is no registered owner or registered override owner, an exception is thrown.
	* If there is no registered owner but there is a registered override owner, the call is routed to the registered override owner.		* If there is no registered owner but there is a registered override owner, the call is routed to the registered override owner.
	* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown~~. For interactively run scripts the timeout behavior differ; see [[AutoScript Timeout Considerations\|Timeout Considerations]]~~.		* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown.

	==== CallBypassOverride ====		==== CallBypassOverride ====

Ivailop: /* CallNonBlocking */

2008-12-12T00:29:05Z

CallNonBlocking

← Older revision		Revision as of 00:29, 12 December 2008
Line 83:		Line 83:
	* The current values of all fields in the ParameterList property are marshaled to the called function.		* The current values of all fields in the ParameterList property are marshaled to the called function.
	* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using ascript.WaitForEvent().		* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using ascript.WaitForEvent().
	* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown~~. For interactively run scripts the timeout behavior differ; see [[AutoScript Timeout Considerations\|Timeout Considerations]]~~.		* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown.
	* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:		* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:
	{\| cellspacing="0" cellpadding="1" width="100%" border="0"		{\| cellspacing="0" cellpadding="1" width="100%" border="0"

Ivailop: /* CallBypassOverrideNonBlocking */

2008-12-12T00:27:51Z

CallBypassOverrideNonBlocking

← Older revision		Revision as of 00:27, 12 December 2008
Line 64:		Line 64:
	* Current values of all fields of the ParameterList property are marshaled to the called function.		* Current values of all fields of the ParameterList property are marshaled to the called function.
	* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using [[AutoScript_Events#WaitForEvent\|ascript.WaitForEvent()]].		* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using [[AutoScript_Events#WaitForEvent\|ascript.WaitForEvent()]].
	* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown~~. For interactively run scripts the timeout behavior differ; see [[AutoScript Timeout Considerations\|Timeout Considerations]]~~.		* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown.
	* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:		* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:
	{\| cellspacing="0" cellpadding="1" width="100%" border="0"		{\| cellspacing="0" cellpadding="1" width="100%" border="0"

Chrisj: /* OutPointers */

2008-09-19T21:53:04Z

OutPointers

← Older revision		Revision as of 21:53, 19 September 2008
Line 39:		Line 39:

	=== OutPointers ===		=== OutPointers ===
	This payload exists only if a function's payload has at least one pointer that is qualified as OUT or INOUT. In other words, the function returns an object via a pointer through its parameter list.		This payload exists only if a function's payload has at least one pointer that is qualified as "OUT" or "INOUT". In other words, the function returns an object via a pointer through its parameter list.

	If this property exists, its members are comprised of all the top-level parameters that are either OUT or INOUT pointers. This can also exist for structured types (structs or unions) that contain members that are OUT or INOUT. It can also exist if a structured type contains a nested structured type that contains members that are OUT or INOUT. In the case of structured type objects appearing in the OutPointers hierarchy, only members that are qualified as OUT or INOUT (or that themselves contain these qualified types) are available.		If this property exists, its members are comprised of all the top-level parameters that are either "OUT" or "INOUT" pointers. This can also exist for structured types (structs or unions) that contain members that are "OUT" or "INOUT". It can also exist if a structured type contains a nested structured type that contains members that are "OUT" or "INOUT". In the case of structured type objects appearing in the OutPointers hierarchy, only members that are qualified as "OUT" or "INOUT" (or that themselves contain these qualified types) are available.

	Upon a function's return, the OutPointers property of the [[AutoScript#ascript.Functions.Item.User\|Function User]] object (ascript.Functions.Item().User.OutPointers) will reflect (contain) the values set by the [[AutoScript#ascript.Functions.Item.Owner\|Function Owner]] object (ascript.Functions.Item().Owner.OutPointers).		Upon a function's return, the OutPointers property of the [[AutoScript#ascript.Functions.Item.User\|Function User]] object (ascript.Functions.Item().User.OutPointers) will reflect (contain) the values set by the [[AutoScript#ascript.Functions.Item.Owner\|Function Owner]] object (ascript.Functions.Item().Owner.OutPointers).

	=== ParameterList ===		=== ParameterList ===
	A ParameterList payload only exists if the given [[AutoScript#ascript.Functions.Item.Owner\|Function Owner]] contains one or more parameters. This payload will contain the values of all ParameterList fields at the time the function User called the Owner (on the user side before a call). The ParameterList payload is a [[AutoScript_Dynamic_Objects\|Dynamic Object]]. This payload will contain all the ParameterList field results after a call (on the owner side after a call).		A ParameterList payload only exists if the given [[AutoScript#ascript.Functions.Item.Owner\|Function Owner]] contains one or more parameters. This payload will contain the values of all ParameterList fields at the time the function User called the Owner (on the user side before a call). The ParameterList payload is a [[AutoScript_Dynamic_Objects\|Dynamic Object]]. This payload will contain all the ParameterList field results after a call (on the owner side after a call).

Stevel at 19:33, 21 August 2008

2008-08-21T19:33:06Z

Stevel at 19:22, 21 August 2008

2008-08-21T19:22:21Z

← Older revision		Revision as of 19:22, 21 August 2008
Line 63:		Line 63:
	* If there is no registered owner but there is a registered override owner, the call is routed to the registered override owner.		* If there is no registered owner but there is a registered override owner, the call is routed to the registered override owner.
	* Current values of all fields of the ParameterList property are marshaled to the called function.		* Current values of all fields of the ParameterList property are marshaled to the called function.
	* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using [[~~Events~~#WaitForEvent\|ascript.WaitForEvent()]].		* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using [[AutoScript_Events#WaitForEvent\|ascript.WaitForEvent()]].
	* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown. For interactively run scripts the timeout behavior differ; see [[Timeout Considerations\|Timeout Considerations]].		* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown. For interactively run scripts the timeout behavior differ; see [[Timeout Considerations\|Timeout Considerations]].
	* The object returned from [[~~Events~~#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:		* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:
	{\| cellspacing="0" cellpadding="1" width="100%" border="0"		{\| cellspacing="0" cellpadding="1" width="100%" border="0"
	\|-		\|-
Line 84:		Line 84:
	* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using ascript.WaitForEvent().		* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using ascript.WaitForEvent().
	* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown. For interactively run scripts the timeout behavior differ; see [[Timeout Considerations\|Timeout Considerations]].		* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown. For interactively run scripts the timeout behavior differ; see [[Timeout Considerations\|Timeout Considerations]].
	* The object returned from [[~~Events~~#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:		* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:
	{\| cellspacing="0" cellpadding="1" width="100%" border="0"		{\| cellspacing="0" cellpadding="1" width="100%" border="0"
	\|-		\|-

← Older revision		Revision as of 00:27, 12 December 2008
Line 64:		Line 64:
	* Current values of all fields of the ParameterList property are marshaled to the called function.		* Current values of all fields of the ParameterList property are marshaled to the called function.
	* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using [[AutoScript_Events#WaitForEvent\|ascript.WaitForEvent()]].		* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using [[AutoScript_Events#WaitForEvent\|ascript.WaitForEvent()]].
	* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown~~. For interactively run scripts the timeout behavior differ; see [[AutoScript Timeout Considerations\|Timeout Considerations]]~~.		* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown.
	* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:		* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:
	{\| cellspacing="0" cellpadding="1" width="100%" border="0"		{\| cellspacing="0" cellpadding="1" width="100%" border="0"

← Older revision		Revision as of 19:33, 21 August 2008
Line 64:		Line 64:
	* Current values of all fields of the ParameterList property are marshaled to the called function.		* Current values of all fields of the ParameterList property are marshaled to the called function.
	* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using [[AutoScript_Events#WaitForEvent\|ascript.WaitForEvent()]].		* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using [[AutoScript_Events#WaitForEvent\|ascript.WaitForEvent()]].
	* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown. For interactively run scripts the timeout behavior differ; see [[Timeout Considerations\|Timeout Considerations]].		* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown. For interactively run scripts the timeout behavior differ; see [[AutoScript Timeout Considerations\|Timeout Considerations]].
	* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:		* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:
	{\| cellspacing="0" cellpadding="1" width="100%" border="0"		{\| cellspacing="0" cellpadding="1" width="100%" border="0"
Line 83:		Line 83:
	* The current values of all fields in the ParameterList property are marshaled to the called function.		* The current values of all fields in the ParameterList property are marshaled to the called function.
	* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using ascript.WaitForEvent().		* This method returns to the caller immediately. When the function owner (running in a separate thread) returns, an event is placed in this script's queue by the STRIDE Runtime. The event (as a polymorphic object exposing Type and Name properties) is retrieved from the queue using ascript.WaitForEvent().
	* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown. For interactively run scripts the timeout behavior differ; see [[Timeout Considerations\|Timeout Considerations]].		* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown. For interactively run scripts the timeout behavior differ; see [[AutoScript Timeout Considerations\|Timeout Considerations]].
	* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:		* The object returned from [[AutoScript_Events#WaitForEvent\|WaitForEvent()]] in response to CallByPassOverrideNonBlocking() can be:
	{\| cellspacing="0" cellpadding="1" width="100%" border="0"		{\| cellspacing="0" cellpadding="1" width="100%" border="0"
Line 101:		Line 101:
	* If there is no registered owner or registered override owner, an exception is thrown.		* If there is no registered owner or registered override owner, an exception is thrown.
	* If there is no registered owner but there is a registered override owner, the call is routed to the registered override owner.		* If there is no registered owner but there is a registered override owner, the call is routed to the registered override owner.
	* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown. For interactively run scripts the timeout behavior differ; see [[Timeout Considerations\|Timeout Considerations]].		* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown. For interactively run scripts the timeout behavior differ; see [[AutoScript Timeout Considerations\|Timeout Considerations]].

	==== CallBypassOverride ====		==== CallBypassOverride ====
Line 109:		Line 109:
	* If there is no registered owner or registered override owner, an exception is thrown.		* If there is no registered owner or registered override owner, an exception is thrown.
	* If there is no registered owner but there is a registered override owner, the call is routed to the registered override owner.		* If there is no registered owner but there is a registered override owner, the call is routed to the registered override owner.
	* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown. For interactively run scripts the timeout behavior differ; see [[Timeout Considerations\|Timeout Considerations]].		* If the [[AutoScript#Ascript API\|RspTimeoutPeriod]] is non-zero and the call does not complete in the specified time, an exception is thrown. For interactively run scripts the timeout behavior differ; see [[AutoScript Timeout Considerations\|Timeout Considerations]].

	=== Returns ===		=== Returns ===