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)

Syntax

'Declaration
<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.")> _
<GuidAttribute("E0C0FFE1-7eea-4ee2-b7e4-0080c7eb0b74")> _
<InterfaceTypeAttribute(ComInterfaceType.InterfaceIsIUnknown)> _
Public Interface IVsaEngine

[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.")]
[GuidAttribute("E0C0FFE1-7eea-4ee2-b7e4-0080c7eb0b74")]
[InterfaceTypeAttribute(ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsaEngine

[ObsoleteAttribute(L"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.")]
[GuidAttribute(L"E0C0FFE1-7eea-4ee2-b7e4-0080c7eb0b74")]
[InterfaceTypeAttribute(ComInterfaceType::InterfaceIsIUnknown)]
public interface class IVsaEngine

[<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.")>]
[<GuidAttribute("E0C0FFE1-7eea-4ee2-b7e4-0080c7eb0b74")>]
[<InterfaceTypeAttribute(ComInterfaceType.InterfaceIsIUnknown)>]
type IVsaEngine =  interface end

public interface IVsaEngine

The IVsaEngine type exposes the following members.

Properties

	Name	Description
	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	Sets or gets a Boolean value that signifies whether the script engine produces debug information when the Compile method is called.
	IsCompiled
	IsDirty	Gets 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.
	IsRunning	Gets a Boolean value that reports 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 nonlocalized 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	Sets or gets the display name of the script engine that is used primarily for identifying individual script engines to users in a hosted environment.
	RootMoniker	Sets or gets a script engine's root moniker.
	RootNamespace	Sets or gets the root namespace used by the script engine.
	Site	Sets or gets 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.

Top

Methods

	Name	Description
	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	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	Checks whether the supplied identifier is valid for the script engine.
	LoadSourceState	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	Saves the compiled state of the script engine; optionally, it also saves debugging information.
	SaveSourceState	Directs the script engine to persist its source state to the specified IVsaPersistSite object.
	SetOption	Sets implementation-specific options for a script engine.

Top

See Also

Reference

Microsoft.Vsa Namespace