Microsoft.Vsa

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

Adds an event source to the code item. The code item uses the event source to hook up an event to the named event source by calling the method, which is implemented by the host.

A programmatic name of the event source. The type name of the event source.

Appends specified text to the end of the code item.

The text to be appended to the code item.

Gets the code document object model (CodeDOM) represented in the code item.

Sets or gets the text of a specified code item, including auto-generated code, if any.

Returns the source text of the code item.

Represents a code item to be compiled by the script engine.

Removes the specified event source from the code item.

The programmatic name of the event source to be removed.

Gets a reference to the running assembly generated by the method.

Reference to the currently running assembly.

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

Causes the script engine to compile the existing source state.

Sets or gets a Boolean value that signifies whether the script engine produces debug information when the method is called.

Gets implementation-specific options for a script engine.

The name of the option to get. Returns the value of the option.

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

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

Gets a Boolean value that signifies whether a script engine has successfully compiled the current source state.

Returns if the current source state of the engine is successfully compiled. Returns if the script engine does not have a valid compiled state. The default value for this property is .

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.

Returns if the script engine is dirty. Returns if the script engine is not dirty. The default value for this property is .

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

Returns if the script engine is running. Returns if the script engine is not running. The default value for this property is .

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

A string value provided as identifier. Returns if the identifier is valid; otherwise, it returns .

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

Returns an collection.

Gets the nonlocalized name of the programming language supported by the script engine.

Returns the English-language name of the programming language supported by the script engine.

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

Returns an integer value representing the locale in which exception messages are to be reported.

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

The site from which the specified source items is loaded.

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.

Returns the value of the script engine's property, which may be the empty string.

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

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

Sets or gets a script engine's root moniker.

Returns the current value of the property.

Sets or gets the root namespace used by the script engine.

Returns the string value of the root namespace.

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

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

The compiled state of the script engine. Specifies debugging information contained in the .PDB file corresponding to the PE (portable executable).

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

The site established by the interface to which source state is saved.

Sets implementation-specific options for a script engine.

The name of the option to set. The value for the option being set.

Sets or gets the host-implemented object that is used by the script engine to communicate with the host.

Returns a reference to the current object.

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

String value of the current version, in the format Major.Minor.Revision.Build.

Gets the ending column number for the source text that caused the error, if available.

Gets a brief description of the error, in some instances returning a reference to the token(s) in the source code that are causing the error.

Gets a number that uniquely identifies the error.

Provides access to compilation errors encountered during execution of the method.

Gets the line number on which an error occurs.

Gets the text of the source code from the line that caused the error.

Sets the severity of the error.

Gets the fully qualified name of the source item that contained the error, in a format recognizable by the script engine.

Gets a reference to the object that generated the error.

Gets the starting column number for the source text that caused the error, if available.

Sets a value indicating whether the members of the global object should be made available to the script engine. [Not presently supported.]

Describes global objects added to the script engine.

Gets or sets the type of the global item.

Gets implementation-specific options for a script engine.

The name of the option to retrieve. Returns the value of the specified option.

Returns a value indicating whether the current in-memory representation of the item differs from the persisted representation.

Returns if the item is dirty, and thus requires saving; returns if the item is not dirty.

Gets the specified object's type, as determined by the method.

A type as enumerated by the enumeration.

Sets or gets the name of the item.

Defines an interface for all items added to .NET script engine, including code items, reference items, and global items. It defines generic properties and methods that apply to all item types recognized by the engine.

Gets the number of items in the specified collection.

Returns the integer value for the number of items in the collection.

Creates a new instance of one of the types, as defined in the enumeration.

The name to associate with the new item. The type of item created, as defined in the enumeration. The optional flag to specify the initial content of a Code item.

Sets implementation-specific options for a script engine.

The name of the option to set. A new value for the option.

Defines an interface for a collection of objects, which can be addressed either by name or by index.

Gets an item from the collection by its index value.

A 0-based index of the retrievable items. Returns the item at the specified index.

Gets an item from the collection by its name.

The name of the item to retrieve from the collection. Returns the item specified by name.

Removes an item from the collection, as specified by its index value.

The index value of the item to be removed.

Removes an item from the collection, as specified by its name.

The name of the item to be removed from the collection.

Manages project persistence and stores and retrieves code and other items using save and load operations implemented by the host.

Gets the source string previously saved using the method.

The name of the code item to be loaded. This can be a null reference when loading the Project file. Returns the contents of the source-code element associated with the parameter.

Saves an arbitrary source string with a given parameter, which can then be used in a call to the method to reload the string.

A name to associate with the specified source item. This can be a null reference when saving the Project file.. The source string for the item.

Gets or sets the name of the referenced assembly.

Describes a reference added to the script engine.

Gets the compiled state of a script engine, and, optionally, associated debugging information.

The compiled state of the engine; an assembly in byte form. The debugging information for the assembly, or a null reference if such information does not exist or is not available.

Gets a reference to an event source previously added to a script engine using the method.

The specified item name. The specified event source name. Returns the event source to the engine.

Gets a reference to a global item, such as the host-provided application object.

The specified name of the global object to retrieve. Returns a reference to the global object.

Enables communication between the host and the script engine. This interface is implemented by the host.

Notifies the host about events generated by the .NET script engine.

A string identifying the notification. An object containing additional information about the notification.

Notifies the host about compiler errors encountered by the script engine.

The object representing the offending error.

Defines the set of exceptions that can be thrown by a .NET script engine.

Value: 0x80133000 Exception string: The application domain cannot be set.Thrown by the or methods when attempts fail to set the AppDomain option on a managed engine, such as the Visual Basic .NET or JScript .NET script engines. Managed script engines do not support using custom application domains. Managed script engines will always use the application domain in which they are running.

Value: 0x80133001 Exception string: The specified application domain is not valid.Thrown by the or methods when attempting to set an reference that is not valid. To reset the option to a null reference, call the method.

Value: 0x80133002 Exception string: Application base cannot be set.Thrown by the or methods when attempts to get or set the ApplicationBase option on a managed engine, such as the Visual Basic .NET or JScript .NET script engines. The host must set the option in the application domain in which it creates its script engine.

Value: 0x80133003 Exception string: The specified application base directory is not valid.Thrown by the or methods when attempts to get or set the ApplicationBase option on an engine, and by the method when the directory specified as the Application Base directory is not a valid directory.

Value: 0x80133004 Exception string: does not reference a valid assembly.Thrown by the method when one of the objects contained in the collection does not represent a valid assembly.

Value: 0x80133005 Exception string: Assembly name is not valid.Thrown by the property when an assembly name that is not valid is specified for an object.

Value: 0x80133006 Exception string: Assembly format is not valid.Thrown when the assembly provided to the engine is not valid. This exception typically occurs when an engine tries to run or use the assembly.

Value: 0x80133007 Exception string: The cached assembly is not valid.Thrown by the method when it is called and it tries to use a previously cached assembly, but the assembly is not valid, for example, it is .

Value: 0x80133008 Exception string: Callback cannot be made at this time.Thrown by multiple methods when one of the or callback methods is called at an unexpected time. For example, the method should only be called by an engine as a result of a call to the method. If it is called at any other time, a CallbackUnexpected exception will be thrown.

Value: 0x80133009 Exception string: A valid Code Document Object Model (CodeDOM) is not available.Thrown by the property when the property is not available to be read. The engine either does not support the property or it requires an explicit call to the method in order to generate the Document Object Model (DOM).

Value: 0x8013300A Exception string: The specified compiled state could not be loaded.Thrown by the method when it is called for an engine that does not have compiled state.

Value: 0x8013300B Exception string: The use of debug information is not supported.Thrown by the property when it is set to , but the engine does not support the generation of debugging information. Compilation continues, but the engine compiles code without debug information.

Value: 0x8013300C Exception string: The element name is not valid.Thrown by the and methods when either is called with a name parameter that is not valid, for example, one that contains characters that are not valid. Note that the host must not throw an ElementNameInvalid Exception when the parameter is a null pointer, as a null pointer is a valid argument used to request engine-level data.

Value: 0x8013300D Exception string: The element was not found.Thrown by method when it is called with a name parameter that is not valid, that is, one that does not correspond to a previously saved element.

Value: 0x8013300E Exception string: Engine is busy servicing another thread.Thrown by all members when an engine is currently servicing a request from another thread. By design, a .NET script engine should only be called from one thread at a time.

Value: 0x8013300F Exception string: The specified engine cannot be closed.Thrown by method when an attempt is made to call this method, but the.NET script engine cannot be closed properly.

Value: 0x80133010 Exception string: The specified engine cannot be reset.Thrown by the method when it is called, but the .NET script engine could not be reset or its events could not be unhooked.

Value: 0x80133011 Exception string: Engine has been closed.Thrown in most cases after the .NET script engine has been closed using a call to the method. Once the method has been called, the engine can no longer be used, and a new script engine must be created to perform any tasks.

Value: 0x80133012 Exception string: The specified engine has no source items to compile.Thrown by the method when it is called, but there are no items in the collection to compile, that is, the property = 0.

Value: 0x80133013 Exception string: Engine has already been initialized.Thrown by the and methods when these methods are called but the .NET script engine has already been initialized. If the host wants to load source state or initialize a new script engine, the respective methods must be the first ones called after setting the and properties.

Value: 0x80133014 Exception string: The specified engine name is already in use by another engine.Thrown by property when an attempt is made to set it to the same name as that of an existing .NET script engine inside the host. While the property does not need to be globally unique, it cannot be the same as the name of a script engine that is currently being hosted.

Value: 0x80133015 Exception string: The specified engine is not compiled.Thrown by the and methods when there is no compiled state to run or save. Either the .NET script engine must compile the code with a call to the method, or the method must be called before the script engine can be run or saved.

Value: 0x80133016 Exception string: The specified engine has not been initialized.Thrown by multiple members when the .NET script engine has not been properly initialized, and the host tries to access a property or method that requires the script engine to be initialized.

Value: 0x80133017 Exception string: The specified engine must be running.Thrown by the method and property when either is called and the specified .NET script engine is not running.

Value: 0x80133018 Exception string: Engine is running.Thrown by multiple members when the .NET script engine is running, and the host attempts to perform an operation that is not allowed while the script engine is running. For example, attempting to create a new code item using the method will produce this exception if the engine is in the running state.

Value: 0x80133019 Exception string: The specified event source does not exist.Thrown by the method when it is called with a parameter or pairing of parameters that is not valid. Either the itemName parameter refers to an item that the host did not add to the engine, or the eventSourceName parameter refers to an event source that was not added to the specified item.

Value: 0x8013301A Exception string: The specified event source name is already in use.Thrown by the method when it is called with an eventSourceName parameter that has previously been used as an event source name.

Value: 0x8013301B Exception string: The specified event source name is not valid.Thrown by the and methods when either is called with an eventSourceName parameter that is not a valid identifier. Hosts can determine whether an identifier is valid by first calling the method.

Value: 0x8013301C Exception string: The specified event source not found.Thrown by the method when it is called with an eventNameType parameter that is not already in use as an event source in the code item.

Value: 0x8013301D Exception string: The specified event source type is not valid.Thrown by the method when it is called with an eventSourceType parameter that is not a valid type. Note that this is not true for the Visual Basic .NET script engine, which instead reports a compile exception in this situation.

Value: 0x8013301E Exception string: The specified compiled state could not be loaded.Thrown by the and methods when the method fails. The method returns to the caller the exception returned by the method. The method may also generate the GetCompiledStateFailed exception if the assembly cache throws an exception.

Value: 0x8013301F Exception string: The specified global instance does not exist.Thrown by method when it is called with an invalid name parameter, that is, one that was not added using the method.

Value: 0x80133020 Exception string: Global instance type is not valid.Thrown when the property of an object is not valid.

Value: 0x80133021 Exception string: An internal compiler exception has occurred.Thrown by the method when it is called and an unexpected exception occurs within the compiler. This exception is not thrown for compilation errors, which are signaled to the host by means of the method, but for exceptions in the compiler itself.

Value: 0x80133022 Exception string: The specified item cannot be removed.Thrown by the and methods when an attempt is made to remove an item that cannot be removed.

Value: 0x80133023 Exception string: The specified flag is not supported.Thrown by the method when the call specifies a flag that is not valid, or a flag that is not supported by the host.

Value: 0x80133024 Exception string: The specified item's name is already in use.Thrown by the method and the property when a call to the method is made with a parameter that is already in use, or when an existing item has its property set to a name that is already in use.

Value: 0x80133025 Exception string: Item name is not valid.Thrown by the method and property when the name of an item is not valid. The name of an item can be set either when calling the method, or when setting the property. Use the method to determine whether an identifier is valid for the engine.

Value: 0x80133026 Exception string: The specified item not found in the collection.Thrown by the property, method, property, and method when the property is indexed using a parameter that is not valid. When using the string overload, the parameter must be the same as the name of an item already in the collection; when using the int overload, the parameter must be between 0 and the value of the property -1, inclusive.

Value: 0x80133027 Exception string: The specified item type is not supported.Thrown by the method when a call is made with an parameter that is not supported by the engine. Note that not all engines support all the values of the enumeration.

Value: 0x80133028 Exception string: The specified locale identifier (LCID) is not supported.Thrown by the property when it is set to an LCID that is not supported by the engine.

Value: 0x80133029 Exception string: The specified element could not be loaded.Thrown by the and methods when a call to the method fails. The method returns the LoadElementFailed exception from the method.

Value: 0x8013302A Exception string: The specified notification is not valid.Thrown by the method when it is called with a notification that is not valid. It is generally recommended that host applications ignore notifications of which they are not aware, or to which they do not need to respond. However, in cases where they do handle a specific notification and the notification is not valid, hosts should throw the NotificationInvalid exception.

Value: 0x8013302B Exception string: The specified option is not valid.Thrown by the and methods when the host attempts to set an option using either method, but the value supplied is not valid for the option.

Value: 0x8013302C Exception string: The specified option is not supported.Thrown by the , , and methods when trying to get or set an option that is not supported by the engine.

Value: 0x8013302D Exception string: A request to revoke the assembly cache failed.Thrown by the method when it is called, but it cannot revoke the cache. More information may be available by means of the property. Note that if there is no cached assembly to revoke, the engine should return "success" and not throw this exception.

Value: 0x8013302E Exception string: The property has already been set and cannot be set again.Thrown by the property when an attempt is made to set this property after it has already been set to a valid value. The property can only be set once.

Value: 0x8013302F Exception string: The specified root moniker is already in use.Thrown by the property when an attempt is made to set this property to a value that is already in use by another engine. The property must be globally unique.

Value: 0x80133030 Exception string: The specified root moniker is not valid.Thrown by the property when an attempt is made to set this property to a value that is not a valid moniker. A moniker can be invalid for the following reasons:It does not adhere to the moniker syntax of <protocol>://<path>.It uses characters that are not valid inside a Uniform Resource Identifier (URI). For more information about valid characters, see "Request For Comments 2396" at http://www.ietf.org/rfc/rfc2396.

Value: 0x80133031 Exception string: The property has not been set.Thrown by the , , , and methods, and the property when the property or method requires a valid root moniker, but the property has not been set.

Value: 0x80133032 Exception string: The protocol specified in the root moniker is not valid.Thrown by the property when an attempt is made to set this property to a value that uses a protocol already registered on the machine, such as file or http. Registered protocols cannot be used as part of the moniker.

Value: 0x80133033 Exception string: The specified root namespace is not valid.Thrown by the property when an attempt is made to set this property to a value that is not a valid namespace identifier.

Value: 0x80133034 Exception string: The root namespace has not been set.Thrown by the method if it is called before the property is set. The runtime loader engine and the Visual Basic .NET script engine will also throw this exception on calling the method if the property has not been set.

Value: 0x80133035 Exception string: The specified compiled state could not be saved.Thrown by the method when this method fails. Note that this method does not actually save code, but rather simply provides the host application with the specified binary data, so that the host can save it.

Value: 0x80133036 Exception string: The specified element could not be saved.Thrown by the and methods when a call to the method fails. The property of the class is set to the actual exception thrown by the underlying code (for example, an out of disk space exception). For more information, see . The method returns the SaveElementFailed exception from the method back to the caller.

Value: 0x80133037 Exception string: The specified site has already been set.Thrown by the property when an attempt is made to set this property and it already has a non-null value. Once it has been set, the property cannot be reset.

Value: 0x80133038 Exception string: The specified site is not valid.Thrown by the property when an attempt is made to set this property to a value that is not a valid object reference.

Value: 0x80133039 Exception string: Site has not been set.Thrown by the , , , and methods when a property or method that requires a valid object is called, but the property has not been set.

Value: 0x8013303A Exception string: Source item is not available for this exception.Thrown when there is no source item for an exception, that is, the property is not set.

Value: 0x8013303B Exception string: Source moniker is not available for this exception.Thrown when there is no moniker for an exception, that is, the property is not set.

Value: 0x8013303C Exception string: Invalid URL; ASPX file extension is missing.Thrown by the property property when the target URL to which the debugger is set is not valid. The property must be pointing to an ASPX file.

Value: 0x8013303D Exception string: The specified browser was not found.Thrown by the method when a remote debugging session has been initiated and an attempt made to launch the remote browser, but a browser is not available.

Value: 0x8013303E Exception string: Debug target application not started.Thrown by the method when a Windows client debugging session is initiated, but the method is not able to launch the target application that is specified with the TargetEXE option.

Value: 0x8013303F Exception string: Engine name not valid.Thrown by the property if the specified name is already in use by another engine. VSA requires that design-time engine names be unique.

Value: 0x80133040 Exception string: Engine does not exist.Thrown by the property in cases where there are no valid engines from which to retrieve the extensibility object.

Value: 0x80133041 Exception string: File format is not supported.Reserved for future use.

Value: 0x80133042 Exception string: File is of unknown type.Reserved for future use.

Value: 0x80133043 Exception string: The item cannot be renamed.Thrown by the property in cases where an attempt is made to rename an item that cannot be renamed.

Value: 0x80133044 Exception string: Missing source.Reserved for future use.

Value: 0x80133045 Exception string: The method has not been called.Thrown by the method or by the method in cases where either is called before the method has been called, signaling that initialization is complete. In the case of the method, the exception signals that the first engine in the engines collection has not yet been initialized.

Value: 0x80133046 Exception string: The engine name exceeds the allowable length of 256 characters.Thrown by the property in cases where the value set for the engine name exceeds 256 characters.

Value: 0x80133047 Exception string: n/aReserved for future use.

Value: 0x80133048 Exception string: n/aReserved for future use.

Value: 0x80133049 Exception string: n/aReserved for future use.

Value: 0x8013304A Exception string: n/aReserved for future use.

Value: 0x8013304B Exception string: n/aReserved for future use.

Value: 0x8013304C Exception string: Cannot attach to the specified Web server.Thrown by the method when launching a server-side debugging session and VSA cannot attach the debugger to the specified Web server.

Value: 0x8013304D Exception string: The property for the specified engine is not set.Thrown by the property in cases where an attempt is made to get the property value when the value has not been set.

Value: 0x801330FF Exception string: Unknown exception.Thrown by multiple members when the exception is not recognized.

Identifies the type of code item as Class, Module, or None.

Value: 0 Used when the code item is generic or when the item type does not accept flags, such as the AppGlobal item type of the enumeration. In such cases, no special flags are required to create the item.

Value: 1 Used when the code item is a module.

Value: 2 Used when the code item is a class.

Identifies the item type as Code, Reference, or AppGlobal.

Value: 0 Used to add a reference to an external .NET assembly, which can then be referenced from code. This type is used to create an object.

Value: 1 Used to add a global object to the .NET script engine. This type is used to create an object.

Value: 2 Used to create a code item for storing source code for the .NET script engine.