VsaEngine Class

Reference

Definition

Namespace:: Microsoft.JScript.Vsa

Assembly:: Microsoft.JScript.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

Use of this type is not recommended because it is being deprecated in Visual Studio 2005; there will be no replacement for this feature. Please see the ICodeCompiler documentation for additional help.

Implements IJSVsaEngine interface.

public ref class VsaEngine sealed : Microsoft::Vsa::BaseVsaEngine, Microsoft::JScript::IEngine2, Microsoft::JScript::IRedirectOutput

public ref class VsaEngine sealed : Microsoft::JScript::Vsa::BaseVsaEngine, Microsoft::JScript::IEngine2, Microsoft::JScript::IRedirectOutput

[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("B71E484D-93ED-4b56-BFB9-CEED5134822B")]
public sealed class VsaEngine : Microsoft.Vsa.BaseVsaEngine, Microsoft.JScript.IEngine2, Microsoft.JScript.IRedirectOutput

[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("B71E484D-93ED-4b56-BFB9-CEED5134822B")]
[System.Obsolete("Use of this type is not recommended because it is being deprecated in Visual Studio 2005; there will be no replacement for this feature. Please see the ICodeCompiler documentation for additional help.")]
public sealed class VsaEngine : Microsoft.Vsa.BaseVsaEngine, Microsoft.JScript.IEngine2, Microsoft.JScript.IRedirectOutput

[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("B71E484D-93ED-4b56-BFB9-CEED5134822B")]
[System.Obsolete("Use of this type is not recommended because it is being deprecated in Visual Studio 2005; there will be no replacement for this feature. Please see the ICodeCompiler documentation for additional help.")]
public sealed class VsaEngine : Microsoft.JScript.Vsa.BaseVsaEngine, Microsoft.JScript.IEngine2, Microsoft.JScript.IRedirectOutput

[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Runtime.InteropServices.Guid("B71E484D-93ED-4b56-BFB9-CEED5134822B")>]
type VsaEngine = class
    inherit BaseVsaEngine
    interface IEngine2
    interface IRedirectOutput

[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Runtime.InteropServices.Guid("B71E484D-93ED-4b56-BFB9-CEED5134822B")>]
[<System.Obsolete("Use of this type is not recommended because it is being deprecated in Visual Studio 2005; there will be no replacement for this feature. Please see the ICodeCompiler documentation for additional help.")>]
type VsaEngine = class
    inherit BaseVsaEngine
    interface IEngine2
    interface IRedirectOutput

Public NotInheritable Class VsaEngine
Inherits BaseVsaEngine
Implements IEngine2, IRedirectOutput

Inheritance: Object

BaseVsaEngine
VsaEngine

Inheritance: Object

BaseVsaEngine
VsaEngine

Attributes: ComVisibleAttribute GuidAttribute ObsoleteAttribute

Implements: IEngine2 IRedirectOutput

Constructors

VsaEngine()

This API supports the product infrastructure and is not intended to be used directly from your code.

Initializes a new instance of the VsaEngine class.

VsaEngine(Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code.

Initializes a new instance of the VsaEngine class and optionally sets fast mode.

Fields

applicationPath	Specifies the application path. (Inherited from BaseVsaEngine)
applicationPath	Gets or sets the application path. (Inherited from BaseVsaEngine)
assemblyVersion	Specifies the assembly version. (Inherited from BaseVsaEngine)
assemblyVersion	Gets or sets the assembly version. (Inherited from BaseVsaEngine)
compiledRootNamespace	Specifies the compiled root namespace. (Inherited from BaseVsaEngine)
compiledRootNamespace	Gets or sets the compiled root namespace. (Inherited from BaseVsaEngine)
engineMoniker	Specifies the engine moniker. (Inherited from BaseVsaEngine)
engineMoniker	Gets or sets the engine moniker. (Inherited from BaseVsaEngine)
engineName	Specifies the engine name. (Inherited from BaseVsaEngine)
engineName	Gets or sets the engine name. (Inherited from BaseVsaEngine)
engineSite	Specifies the engine site. (Inherited from BaseVsaEngine)
engineSite	Gets or sets the engine site. (Inherited from BaseVsaEngine)
errorLocale	Specifies the error locale. (Inherited from BaseVsaEngine)
errorLocale	Gets or sets the error locale. (Inherited from BaseVsaEngine)
executionEvidence	Specifies the execution evidence. (Inherited from BaseVsaEngine)
executionEvidence	Gets or sets the execution evidence. (Inherited from BaseVsaEngine)
failedCompilation	Indicates whether the compilation failed. (Inherited from BaseVsaEngine)
failedCompilation	Gets or sets a value that indicates whether the compilation failed. (Inherited from BaseVsaEngine)
genDebugInfo	Indicates whether debug information is generated. (Inherited from BaseVsaEngine)
genDebugInfo	Gets or sets a value that indicates whether debug information is generated. (Inherited from BaseVsaEngine)
haveCompiledState	Indicates whether there is a compiled state. (Inherited from BaseVsaEngine)
haveCompiledState	Gets or sets a value that indicates whether there is a compiled state. (Inherited from BaseVsaEngine)
isClosed	Indicates whether the engine is closed. (Inherited from BaseVsaEngine)
isClosed	Gets or sets a value that indicates whether the engine is closed. (Inherited from BaseVsaEngine)
isDebugInfoSupported	Specifies whether debug information is supported. (Inherited from BaseVsaEngine)
isDebugInfoSupported	Gets or sets a value that indicates whether debug information is supported. (Inherited from BaseVsaEngine)
isEngineCompiled	Indicates whether the engine is compiled. (Inherited from BaseVsaEngine)
isEngineCompiled	Gets or sets a value that indicates whether the engine is compiled. (Inherited from BaseVsaEngine)
isEngineDirty	Indicates whether the current in-memory representation of the item differs from the persisted representation. (Inherited from BaseVsaEngine)
isEngineDirty	Gets or sets a value that indicates whether the current in-memory representation of the item differs from the persisted representation. (Inherited from BaseVsaEngine)
isEngineInitialized	Indicates whether the engine is initialized. (Inherited from BaseVsaEngine)
isEngineInitialized	Gets or sets a value that indicates whether the engine is initialized. (Inherited from BaseVsaEngine)
isEngineRunning	Indicates whether the engine is running. (Inherited from BaseVsaEngine)
isEngineRunning	Gets or sets a value that indicates whether the engine is running. (Inherited from BaseVsaEngine)
loadedAssembly	Specifies the loaded assembly. (Inherited from BaseVsaEngine)
loadedAssembly	Gets or sets the loaded assembly. (Inherited from BaseVsaEngine)
rootNamespace	Gets or sets the root namespace. (Inherited from BaseVsaEngine)
rootNamespace	Gets or sets the root namespace. (Inherited from BaseVsaEngine)
scriptLanguage	Specifies the script language. (Inherited from BaseVsaEngine)
scriptLanguage	Gets or sets the script language. (Inherited from BaseVsaEngine)
startupClass	Specifies the startup class. (Inherited from BaseVsaEngine)
startupClass	Gets or sets the startup class. (Inherited from BaseVsaEngine)
startupInstance	Specifies the startup instance. (Inherited from BaseVsaEngine)
startupInstance	Gets or sets the startup instance. (Inherited from BaseVsaEngine)
vsaItems	Specifies the collection of IVsaItem objects. (Inherited from BaseVsaEngine)
vsaItems	Gets or sets the collection of IVsaItem objects. (Inherited from BaseVsaEngine)

Properties

AppDomain	Gets or sets the application domain. (Inherited from BaseVsaEngine)
AppDomain	Gets or sets the application domain. (Inherited from BaseVsaEngine)
ApplicationBase	Gets or sets the application base. (Inherited from BaseVsaEngine)
ApplicationBase	Gets or sets the application base. (Inherited from BaseVsaEngine)
Assembly	Gets a reference to the running assembly generated by Run method. (Inherited from BaseVsaEngine)
Assembly	Gets a reference to the running assembly generated by Run method. (Inherited from BaseVsaEngine)
Evidence	Gets or sets the evidence for the purpose of validating the current object's identity. (Inherited from BaseVsaEngine)
Evidence	Provides evidence for the purpose of validating the current object's identity. (Inherited from BaseVsaEngine)
GenerateDebugInfo	Gets or sets a value that indicates whether the script engine produces debug information when the Compile method is called. (Inherited from BaseVsaEngine)
GenerateDebugInfo	Gets or sets a Boolean value that signifies whether the script engine produces debug information when the Compile method is called. (Inherited from BaseVsaEngine)
IsCompiled	Gets a value that indicates whether the source is compiled. (Inherited from BaseVsaEngine)
IsCompiled	Gets a value that indicates whether the source is compiled. (Inherited from BaseVsaEngine)
IsDirty	Gets or sets a value that indicates whether the current in-memory representation of the item differs from the persisted representation. (Inherited from BaseVsaEngine)
IsDirty	Gets or sets a value that indicates whether the current in-memory representation of the item differs from the persisted representation. (Inherited from BaseVsaEngine)
IsRunning	Gets a value that indicates whether the engine is currently in run mode. (Inherited from BaseVsaEngine)
IsRunning	Gets a Boolean value that reports whether the engine is currently in run mode. (Inherited from BaseVsaEngine)
Items	Gets the collection of IVsaItems objects, which represent all items added to the engine. (Inherited from BaseVsaEngine)
Items	Gets the collection of IJSVsaItem objects, which represent all items added to the engine. (Inherited from BaseVsaEngine)
Language	Gets the name of the programming language supported by the engine. (Inherited from BaseVsaEngine)
Language	Gets the name of the programming language supported by the engine. (Inherited from BaseVsaEngine)
LCID	Gets or sets the geographical locale and language in which to report exception messages. (Inherited from BaseVsaEngine)
LCID	Gets or sets the geographical locale and language in which to report exception messages. (Inherited from BaseVsaEngine)
LenientGlobalObject	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the lenient global object.
Name	Gets or sets the display name of the engine. (Inherited from BaseVsaEngine)
Name	Gets or sets the display name of the engine. (Inherited from BaseVsaEngine)
RootMoniker	Gets or sets the root moniker used by the engine. (Inherited from BaseVsaEngine)
RootMoniker	Gets or sets a script engine's root moniker. (Inherited from BaseVsaEngine)
RootNamespace	Gets or sets the root namespace used by the engine. (Inherited from BaseVsaEngine)
RootNamespace	Gets or sets the root namespace used by the engine. (Inherited from BaseVsaEngine)
Site	Gets or sets the host-implemented IVsaSite object that is used by the engine to communicate with the host. (Inherited from BaseVsaEngine)
Site	Gets or sets the host-implemented IJSVsaSite object that is used by the engine to communicate with the host. (Inherited from BaseVsaEngine)
Version	Gets the current version of the language compiler supported by the engine, in the form Major.Minor.Revision.Build. (Inherited from BaseVsaEngine)
Version	Gets the current version of the language compiler supported by the engine, in the form `Major.Minor.Revision.Build`. (Inherited from BaseVsaEngine)

Methods

Clone(AppDomain)	This API supports the product infrastructure and is not intended to be used directly from your code. Creates a new identical engine that runs in a new application domain, with the same compiled state and named items.
Close()	Closes the engine. (Inherited from BaseVsaEngine)
Close()	Closes the engine. (Inherited from BaseVsaEngine)
Compile()	Causes the engine to compile the existing source state. (Inherited from BaseVsaEngine)
Compile()	Causes the engine to compile the existing source state. (Inherited from BaseVsaEngine)
CompileEmpty()	This API supports the product infrastructure and is not intended to be used directly from your code. Triggers compilation of all the state currently in the engine. All references, code items, host items, and resources are run through the compiler.
ConnectEvents()	This API supports the product infrastructure and is not intended to be used directly from your code. Communicates to the engine that it can connect any registered event sources that have events to any global event handlers. This method is not implemented in this class.
CreateEngine()	This API supports the product infrastructure and is not intended to be used directly from your code. Creates the engine.
CreateEngineAndGetGlobalScope(Boolean, String[])	This API supports the product infrastructure and is not intended to be used directly from your code. Creates the engine and returns the global scope.
CreateEngineAndGetGlobalScopeWithType(Boolean, String[], RuntimeTypeHandle)	This API supports the product infrastructure and is not intended to be used directly from your code. Creates the engine and returns the global scope with the calling type handle.
CreateEngineAndGetGlobalScopeWithTypeAndRootNamespace(Boolean, String[], RuntimeTypeHandle, String)	This API supports the product infrastructure and is not intended to be used directly from your code. Creates the engine and returns the global scope with the calling type handle and root namespace.
CreateEngineWithType(RuntimeTypeHandle)	This API supports the product infrastructure and is not intended to be used directly from your code. Creates the engine using the specified type.
DisconnectEvents()	This API supports the product infrastructure and is not intended to be used directly from your code. Directs the engine to unhook event sources from event handlers. This method is not implemented.
DoClose()	Closes the engine. (Inherited from BaseVsaEngine)
DoClose()	Closes the engine. (Inherited from BaseVsaEngine)
DoCompile()	Causes the script engine to compile the existing source state. (Inherited from BaseVsaEngine)
DoCompile()	Causes the script engine to compile the existing source state. (Inherited from BaseVsaEngine)
DoLoadSourceState(IJSVsaPersistSite)	Directs the engine to load source items. (Inherited from BaseVsaEngine)
DoLoadSourceState(IVsaPersistSite)	Directs the engine to load source items. (Inherited from BaseVsaEngine)
DoSaveCompiledState(Byte[], Byte[])	Saves the compiled state of the script engine; optionally, it also saves debugging information. (Inherited from BaseVsaEngine)
DoSaveCompiledState(Byte[], Byte[])	Saves the compiled state of the script engine; optionally, it also saves debugging information. (Inherited from BaseVsaEngine)
DoSaveSourceState(IJSVsaPersistSite)	Directs the script engine to persist its source state to the specified object. (Inherited from BaseVsaEngine)
DoSaveSourceState(IVsaPersistSite)	Directs the script engine to persist its source state to the specified object. (Inherited from BaseVsaEngine)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Error(JSVsaError)	Returns an error. (Inherited from BaseVsaEngine)
Error(VsaError)	Returns an error. (Inherited from BaseVsaEngine)
GetAssembly()	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the compiled assembly that is produced by the compilation step.
GetCustomOption(String)	Gets implementation-specific options for the engine. (Inherited from BaseVsaEngine)
GetCustomOption(String)	Gets implementation-specific options for the engine. (Inherited from BaseVsaEngine)
GetGlobalScope()	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the global scope object.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetItem(String)	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the item from the scope that is designated by the specified name.
GetItemAtIndex(Int32)	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the item from the scope that is designated by the specified index value.
GetItemCount()	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the number of items in the scope.
GetMainScope()	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the main scope.
GetModule()	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the code module from the compiled assembly.
GetOption(String)	Gets implementation-specific options for the engine. (Inherited from BaseVsaEngine)
GetOption(String)	Gets implementation-specific options for the engine. (Inherited from BaseVsaEngine)
GetOriginalArrayConstructor()	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the original ArrayConstructor.
GetOriginalObjectConstructor()	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the original ObjectConstructor.
GetOriginalRegExpConstructor()	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the original RegExpConstructor.
GetType()	Gets the Type of the current instance. (Inherited from Object)
InitNew()	Provides a notification that the initialization phase is complete. (Inherited from BaseVsaEngine)
InitNew()	Provides a notification that the initialization phase is complete. (Inherited from BaseVsaEngine)
InitVsaEngine(String, IJSVsaSite)	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes the VsaEngine.
InitVsaEngine(String, IVsaSite)	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes the VsaEngine.
Interrupt()	This API supports the product infrastructure and is not intended to be used directly from your code. Calls Abort() on the thread that is running the script code.
IsValidIdentifier(String)	This API supports the product infrastructure and is not intended to be used directly from your code. Checks whether the supplied identifier is valid for the engine.
IsValidNamespaceName(String)	Checks whether the supplied namespace is valid for the engine. (Inherited from BaseVsaEngine)
IsValidNamespaceName(String)	Checks whether the supplied namespace is valid for the engine. (Inherited from BaseVsaEngine)
LoadCompiledState()	Loads the compiled state. (Inherited from BaseVsaEngine)
LoadCompiledState()	Loads the compiled state. (Inherited from BaseVsaEngine)
LoadSourceState(IJSVsaPersistSite)	Directs the engine to load source items from their point of persistence, as specified by the host-provided object. (Inherited from BaseVsaEngine)
LoadSourceState(IVsaPersistSite)	Directs the engine to load source items. (Inherited from BaseVsaEngine)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
PopScriptObject()	This API supports the product infrastructure and is not intended to be used directly from your code. Removes and returns the object at the top of the global scope stack.
Preconditions(BaseVsaEngine+Pre)	Sets the precondition flags. (Inherited from BaseVsaEngine)
Preconditions(BaseVsaEngine+Pre)	Sets the precondition flags. (Inherited from BaseVsaEngine)
PushScriptObject(ScriptObject)	This API supports the product infrastructure and is not intended to be used directly from your code. Inserts an object at the top of the global scope stack.
RegisterEventSource(String)	This API supports the product infrastructure and is not intended to be used directly from your code. Specifies the name of an item that is marked as an event source, so that the ConnectEvents() method can determine which events to connect.
Reset()	This API supports the product infrastructure and is not intended to be used directly from your code. Removes the engine from the running state and disconnects automatically bound event handlers.
ResetCompiledState()	Resets the compiled state. (Inherited from BaseVsaEngine)
ResetCompiledState()	Resets the compiled state. (Inherited from BaseVsaEngine)
Restart()	This API supports the product infrastructure and is not intended to be used directly from your code. Restarts the engine.
RevokeCache()	Invalidates the cached assembly for the engine, as specified by its root moniker. (Inherited from BaseVsaEngine)
RevokeCache()	Invalidates the cached assembly for the engine, as specified by its root moniker. (Inherited from BaseVsaEngine)
Run()	Initiates execution of compiled code in the engine and binds all event handlers. (Inherited from BaseVsaEngine)
Run()	Initiates execution of compiled code in the engine and binds all event handlers. (Inherited from BaseVsaEngine)
Run(AppDomain)	This API supports the product infrastructure and is not intended to be used directly from your code. Runs the compiled code in the specified application domain.
RunEmpty()	This API supports the product infrastructure and is not intended to be used directly from your code. Runs the compiled code in the current AppDomain.
SaveCompiledState(Byte[], Byte[])	Saves the compiled state of the engine; optionally, it also saves debugging information. (Inherited from BaseVsaEngine)
SaveCompiledState(Byte[], Byte[])	Saves the compiled state of the engine; optionally, it also saves debugging information. (Inherited from BaseVsaEngine)
SaveSourceState(IJSVsaPersistSite)	Directs the engine to persist its source state. (Inherited from BaseVsaEngine)
SaveSourceState(IVsaPersistSite)	Directs the engine to persist its source state. (Inherited from BaseVsaEngine)
ScriptObjectStackTop()	This API supports the product infrastructure and is not intended to be used directly from your code. Returns the object at the top of the global scope stack without removing it.
SetCustomOption(String, Object)	Sets implementation-specific options for the engine. (Inherited from BaseVsaEngine)
SetCustomOption(String, Object)	Sets implementation-specific options for the engine. (Inherited from BaseVsaEngine)
SetOption(String, Object)	Sets implementation-specific options for the engine. (Inherited from BaseVsaEngine)
SetOption(String, Object)	Sets implementation-specific options for the engine. (Inherited from BaseVsaEngine)
SetOutputStream(IMessageReceiver)	This API supports the product infrastructure and is not intended to be used directly from your code. Redirects the specified output stream to a new stream or data storage.
ToString()	Returns a string that represents the current object. (Inherited from Object)
ValidateRootMoniker(String)	Validates the root moniker. (Inherited from BaseVsaEngine)
ValidateRootMoniker(String)	Validates the root moniker. (Inherited from BaseVsaEngine)

Applies to