IVsaEngine Interface

Definition

Warning

This API is now obsolete.

Defines the methods and properties that a script engine must support and provides programmatic access to the script engine.

public interface class IVsaEngine
[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.")]
[System.Runtime.InteropServices.Guid("E0C0FFE1-7eea-4ee2-b7e4-0080c7eb0b74")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsaEngine
type IVsaEngine = interface
Public Interface IVsaEngine
Derived
Attributes

Properties

Assembly

Gets a reference to the running assembly generated by the Run() method.

Evidence

Provides evidence for the purpose of validating the current object's identity.

GenerateDebugInfo

Gets or sets a Boolean value that signifies whether the script engine produces debug information when the Compile() method is called.

IsCompiled

Gets a value that indicates whether the script engine is set to produce debug information when the Compile() method is called.

IsDirty

Gets a value that indicates whether the script engine's source state has changed since the last save operation, or since the script engine was originally loaded.

IsRunning

Gets a value that indicates whether the script engine is currently in run mode.

Items

Gets the IVsaItems collection of IVsaItem objects, which represent all items added to the script engine using the CreateItem method, including code items, reference items, and global items.

Language

Gets the non-localized name of the programming language supported by the script engine.

LCID

Gets or sets the geographical locale and language in which to report exception messages.

Name

Gets or sets the display name of the script engine that is used primarily for identifying individual script engines to users in a hosted environment.

RootMoniker

Gets or sets a script engine's root moniker.

RootNamespace

Gets or sets the root namespace used by the script engine.

Site

Gets or sets the host-implemented IVsaSite object that is used by the script engine to communicate with the host.

Version

Gets the current version of the language compiler supported by the script engine, in the form Major.Minor.Revision.Build.

Methods

Close()

Closes the script engine and releases all resources. If the script engine is currently running, the Reset() method is called first.

Compile()

Causes the script engine to compile the existing source state.

GetOption(String)

Gets implementation-specific options for a script engine.

InitNew()

Provides a notification that the initialization phase is complete and that the script engine is prepared for the addition of IVsaItem objects.

IsValidIdentifier(String)

Checks whether the supplied identifier is valid for the script engine.

LoadSourceState(IVsaPersistSite)

Directs the script engine to load source items from their point of persistence, as specified by the host-provided object that implements the IVsaPersistSite interface.

Reset()

Removes the script engine from the running state and disconnects automatically bound event handlers.

RevokeCache()

Invalidates the cached assembly for a script engine, as specified by its root moniker.

Run()

Initiates execution of compiled code in the script engine and binds all event handlers.

SaveCompiledState(Byte[], Byte[])

Saves the compiled state of the script engine; optionally, it also saves debugging information.

SaveSourceState(IVsaPersistSite)

Directs the script engine to persist its source state to the specified IVsaPersistSite object.

SetOption(String, Object)

Sets implementation-specific options for a script engine.

Applies to