ClearScript Library
ClearScript Library
ClearScript Library Reference
Microsoft.ClearScript.V8
V8ScriptEngine Class
V8ScriptEngine Methods
BeginCpuProfile Method
CancelAwaitDebugger Method
CancelInterrupt Method
CollectCpuProfileSample Method
CollectGarbage Method
Compile Method
CompileDocument Method
Dispose Method
EndCpuProfile Method
Evaluate Method
Execute Method
ExecuteCommand Method
GetRuntimeHeapInfo Method
GetStackTrace Method
Interrupt Method
WriteRuntimeHeapSnapshot Method

# V8ScriptEngine Methods

The V8ScriptEngine type exposes the following members.

Methods

| Name | Description
--- | --- | ---
| AddCOMObject(String, Guid) | Creates a COM/ActiveX object and exposes it to script code. The registered class is specified by class identifier (CLSID). (Inherited from ScriptEngine)
| AddCOMObject(String, String) | Creates a COM/ActiveX object and exposes it to script code. The registered class is specified by programmatic identifier (ProgID). (Inherited from ScriptEngine)
| AddCOMObject(String, HostItemFlags, Guid) | Creates a COM/ActiveX object and exposes it to script code with the specified options. The registered class is specified by class identifier (CLSID). (Inherited from ScriptEngine)
| AddCOMObject(String, HostItemFlags, String) | Creates a COM/ActiveX object and exposes it to script code with the specified options. The registered class is specified by programmatic identifier (ProgID). (Inherited from ScriptEngine)
| AddCOMObject(String, Guid, String) | Creates a COM/ActiveX object on the specified server and exposes it to script code. The registered class is specified by class identifier (CLSID). (Inherited from ScriptEngine)
| AddCOMObject(String, String, String) | Creates a COM/ActiveX object on the specified server and exposes it to script code. The registered class is specified by programmatic identifier (ProgID). (Inherited from ScriptEngine)
| AddCOMObject(String, HostItemFlags, Guid, String) | Creates a COM/ActiveX object on the specified server and exposes it to script code with the specified options. The registered class is specified by class identifier (CLSID). (Inherited from ScriptEngine)
| AddCOMObject(String, HostItemFlags, String, String) | Creates a COM/ActiveX object on the specified server and exposes it to script code with the specified options. The registered class is specified by programmatic identifier (ProgID). (Inherited from ScriptEngine)
| AddCOMType(String, Guid) | Imports a COM/ActiveX type and exposes it to script code. The registered class is specified by class identifier (CLSID). (Inherited from ScriptEngine)
| AddCOMType(String, String) | Imports a COM/ActiveX type and exposes it to script code. The registered class is specified by programmatic identifier (ProgID). (Inherited from ScriptEngine)
| AddCOMType(String, HostItemFlags, Guid) | Imports a COM/ActiveX type and exposes it to script code with the specified options. The registered class is specified by class identifier (CLSID). (Inherited from ScriptEngine)
| AddCOMType(String, HostItemFlags, String) | Imports a COM/ActiveX type and exposes it to script code with the specified options. The registered class is specified by programmatic identifier (ProgID). (Inherited from ScriptEngine)
| AddCOMType(String, Guid, String) | Imports a COM/ActiveX type from the specified server and exposes it to script code. The registered class is specified by class identifier (CLSID). (Inherited from ScriptEngine)
| AddCOMType(String, String, String) | Imports a COM/ActiveX type from the specified server and exposes it to script code. The registered class is specified by programmatic identifier (ProgID). (Inherited from ScriptEngine)
| AddCOMType(String, HostItemFlags, Guid, String) | Imports a COM/ActiveX type from the specified server and exposes it to script code with the specified options. The registered class is specified by class identifier (CLSID). (Inherited from ScriptEngine)
| AddCOMType(String, HostItemFlags, String, String) | Imports a COM/ActiveX type from the specified server and exposes it to script code with the specified options. The registered class is specified by programmatic identifier (ProgID). (Inherited from ScriptEngine)
| AddHostObject(String, Object) | Exposes a host object to script code. (Inherited from ScriptEngine)
| AddHostObject(String, HostItemFlags, Object) | Exposes a host object to script code with the specified options. (Inherited from ScriptEngine)
| AddHostType(Type) | Exposes a host type to script code with a default name. (Inherited from ScriptEngine)
| AddHostType(HostItemFlags, Type) | Exposes a host type to script code with a default name and the specified options. (Inherited from ScriptEngine)
| AddHostType(String, Type) | Exposes a host type to script code. (Inherited from ScriptEngine)
| AddHostType(String, HostItemFlags, Type) | Exposes a host type to script code with the specified options. (Inherited from ScriptEngine)
| AddHostType(String, String, Type) | Exposes a host type to script code. The type is specified by name. (Inherited from ScriptEngine)
| AddHostType(String, HostItemFlags, String, Type) | Exposes a host type to script code with the specified options. The type is specified by name. (Inherited from ScriptEngine)
| AddHostType(String, String, String, Type) | Exposes a host type to script code. The type is specified by type name and assembly name. (Inherited from ScriptEngine)
| AddHostType(String, HostItemFlags, String, String, Type) | Exposes a host type to script code with the specified options. The type is specified by type name and assembly name. (Inherited from ScriptEngine)
| AddHostTypes | Exposes host types to script code. (Inherited from ScriptEngine)
| AddRestrictedHostObjectT(String, T) | Exposes a host object to script code with the specified type restriction. (Inherited from ScriptEngine)
| AddRestrictedHostObjectT(String, HostItemFlags, T) | Exposes a host object to script code with the specified type restriction and options. (Inherited from ScriptEngine)
| BeginCpuProfile(String) | Begins collecting a new CPU profile.
| BeginCpuProfile(String, V8CpuProfileFlags) | Begins collecting a new CPU profile with the specified options.
| CancelAwaitDebugger | Resumes script execution if the script engine is waiting for a debugger connection.
| CancelInterrupt | Cancels any pending request to interrupt script execution.
| CollectCpuProfileSample | Collects a sample in all CPU profiles active in the V8 runtime.
| CollectGarbage | Performs garbage collection. (Overrides ScriptEngineCollectGarbage(Boolean))
| Compile(String) | Creates a compiled script.
| Compile(DocumentInfo, String) | Creates a compiled script with the specified document meta-information.
| Compile(String, String) | Creates a compiled script with an associated document name.
| Compile(String, V8CacheKind, Byte) | Creates a compiled script, generating cache data for accelerated recompilation.
| Compile(DocumentInfo, String, V8CacheKind, Byte) | Creates a compiled script with the specified document meta-information, generating cache data for accelerated recompilation.
| Compile(String, V8CacheKind, Byte, Boolean) | Creates a compiled script, consuming previously generated cache data.
| Compile(String, V8CacheKind, Byte, V8CacheResult) | Creates a compiled script, consuming previously generated cache data and updating it if necessary.
| Compile(String, String, V8CacheKind, Byte) | Creates a compiled script with an associated document name, generating cache data for accelerated recompilation.
| Compile(DocumentInfo, String, V8CacheKind, Byte, Boolean) | Creates a compiled script with an associated document name, consuming previously generated cache data.
| Compile(DocumentInfo, String, V8CacheKind, Byte, V8CacheResult) | Creates a compiled script with the specified document meta-information, consuming previously generated cache data and updating it if necessary.
| Compile(String, String, V8CacheKind, Byte, Boolean) | Creates a compiled script with an associated document name, consuming previously generated cache data.
| Compile(String, String, V8CacheKind, Byte, V8CacheResult) | Creates a compiled script with an associated document name, consuming previously generated cache data and updating it if necessary.
| CompileDocument(String) | Loads and compiles a script document.
| CompileDocument(String, DocumentCategory) | Loads and compiles a document with the specified category.
| CompileDocument(String, DocumentCategory, DocumentContextCallback) | Loads and compiles a document with the specified category and context callback.
| CompileDocument(String, V8CacheKind, Byte) | Loads and compiles a script document, generating cache data for accelerated recompilation.
| CompileDocument(String, DocumentCategory, V8CacheKind, Byte) | Loads and compiles a document with the specified category, generating cache data for accelerated recompilation.
| CompileDocument(String, V8CacheKind, Byte, Boolean) | Loads and compiles a script document, consuming previously generated cache data.
| CompileDocument(String, V8CacheKind, Byte, V8CacheResult) | Loads and compiles a script document, consuming previously generated cache data and updating it if necessary.
| CompileDocument(String, DocumentCategory, DocumentContextCallback, V8CacheKind, Byte) | Loads and compiles a document with the specified category and context callback, generating cache data for accelerated recompilation.
| CompileDocument(String, DocumentCategory, V8CacheKind, Byte, Boolean) | Loads and compiles a document with the specified category, consuming previously generated cache data.
| CompileDocument(String, DocumentCategory, V8CacheKind, Byte, V8CacheResult) | Loads and compiles a document with the specified category, consuming previously generated cache data and updating it if necessary.
| CompileDocument(String, DocumentCategory, DocumentContextCallback, V8CacheKind, Byte, Boolean) | Loads and compiles a document with the specified category and context callback, consuming previously generated cache data.
| CompileDocument(String, DocumentCategory, DocumentContextCallback, V8CacheKind, Byte, V8CacheResult) | Loads and compiles a document with the specified category and context callback, consuming previously generated cache data and updating it if necessary.
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from ScriptEngine)
| Dispose(Boolean) | Releases the unmanaged resources used by the script engine and optionally releases the managed resources. (Overrides ScriptEngineDispose(Boolean))
| EndCpuProfile | Completes and returns a CPU profile.
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object)
| Evaluate(String) | Evaluates script code. (Inherited from ScriptEngine)
| Evaluate(V8Script) | Evaluates a compiled script.
| Evaluate(DocumentInfo, String) | Evaluates script code with the specified document meta-information. (Inherited from ScriptEngine)
| Evaluate(String, String) | Evaluates script code with an associated document name. (Inherited from ScriptEngine)
| Evaluate(String, Boolean, String) | Evaluates script code with an associated document name, optionally discarding the document after execution. (Inherited from ScriptEngine)
| EvaluateDocument(String) | Loads and evaluates a script document. (Inherited from ScriptEngine)
| EvaluateDocument(String, DocumentCategory) | Loads and evaluates a document with the specified category. (Inherited from ScriptEngine)
| EvaluateDocument(String, DocumentCategory, DocumentContextCallback) | Loads and evaluates a document with the specified category and context callback. (Inherited from ScriptEngine)
| Execute(String) | Executes script code. (Inherited from ScriptEngine)
| Execute(V8Script) | Executes a compiled script.
| Execute(DocumentInfo, String) | Executes script code with the specified document meta-information. (Inherited from ScriptEngine)
| Execute(String, String) | Executes script code with an associated document name. (Inherited from ScriptEngine)
| Execute(String, Boolean, String) | Executes script code with an associated document name, optionally discarding the document after execution. (Inherited from ScriptEngine)
| ExecuteCommand | Executes script code as a command. (Overrides ScriptEngineExecuteCommand(String))
| ExecuteDocument(String) | Loads and executes a script document. (Inherited from ScriptEngine)
| ExecuteDocument(String, DocumentCategory) | Loads and executes a document with the specified category. (Inherited from ScriptEngine)
| ExecuteDocument(String, DocumentCategory, DocumentContextCallback) | Loads and executes a document with the specified category and context callback. (Inherited from ScriptEngine)
| Finalize | Releases unmanaged resources and performs other cleanup operations before the script engine is reclaimed by garbage collection. (Inherited from ScriptEngine)
| GetHashCode | Serves as the default hash function. (Inherited from Object)
| GetRuntimeHeapInfo | Returns memory usage information for the V8 runtime.
| GetStackTrace | Gets a string representation of the script call stack. (Overrides ScriptEngineGetStackTrace)
| GetType | Gets the Type of the current instance. (Inherited from Object)
| Interrupt | Interrupts script execution and causes the script engine to throw an exception. (Overrides ScriptEngineInterrupt)
| Invoke | Invokes a global function or procedure. (Inherited from ScriptEngine)
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object)
| ToString | Returns a string that represents the current object. (Inherited from Object)
| WriteRuntimeHeapSnapshot | Writes a snapshot of the V8 runtime's heap to the given stream.

Top
See Also

#### Reference

V8ScriptEngine Class
Microsoft.ClearScript.V8 Namespace

Copyright © Microsoft Corporation. All rights reserved.

Send comments on this topic to Microsoft