We recommend using Visual Studio 2017
This documentation is archived and is not being maintained.

IVsaEngine Interface

Note: This API is now obsolete.

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

Namespace:  Microsoft.Vsa
Assembly:  Microsoft.Vsa (in Microsoft.Vsa.dll)

[ObsoleteAttribute("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 interface IVsaEngine

The IVsaEngine type exposes the following members.

Public propertyAssemblyGets a reference to the running assembly generated by the Run method.
Public propertyEvidenceProvides evidence for the purpose of validating the current object's identity.
Public propertyGenerateDebugInfoSets or gets a Boolean value that signifies whether the script engine produces debug information when the Compile method is called.
Public propertyIsCompiled
Public propertyIsDirtyGets a Boolean value that reports whether the script engine's source state has changed since the last save operation, or since the script engine was originally loaded.
Public propertyIsRunningGets a Boolean value that reports whether the script engine is currently in run mode.
Public propertyItemsGets 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.
Public propertyLanguageGets the nonlocalized name of the programming language supported by the script engine.
Public propertyLCIDGets or sets the geographical locale and language in which to report exception messages.
Public propertyNameSets or gets the display name of the script engine that is used primarily for identifying individual script engines to users in a hosted environment.
Public propertyRootMonikerSets or gets a script engine's root moniker.
Public propertyRootNamespaceSets or gets the root namespace used by the script engine.
Public propertySiteSets or gets the host-implemented IVsaSite object that is used by the script engine to communicate with the host.
Public propertyVersionGets the current version of the language compiler supported by the script engine, in the form Major.Minor.Revision.Build.

Public methodCloseCloses the script engine and releases all resources. If the script engine is currently running, the Reset method is called first.
Public methodCompileCauses the script engine to compile the existing source state.
Public methodGetOptionGets implementation-specific options for a script engine.
Public methodInitNewProvides a notification that the initialization phase is complete and that the script engine is prepared for the addition of IVsaItem objects.
Public methodIsValidIdentifierChecks whether the supplied identifier is valid for the script engine.
Public methodLoadSourceStateDirects the script engine to load source items from their point of persistence, as specified by the host-provided object that implements the IVsaPersistSite interface.
Public methodResetRemoves the script engine from the running state and disconnects automatically bound event handlers.
Public methodRevokeCacheInvalidates the cached assembly for a script engine, as specified by its root moniker.
Public methodRunInitiates execution of compiled code in the script engine and binds all event handlers.
Public methodSaveCompiledStateSaves the compiled state of the script engine; optionally, it also saves debugging information.
Public methodSaveSourceStateDirects the script engine to persist its source state to the specified IVsaPersistSite object.
Public methodSetOptionSets implementation-specific options for a script engine.