ClearScript Library
ClearScript Library
ClearScript Library Reference
Microsoft.ClearScript.V8
V8Runtime Class
V8Runtime Methods
CompileDocument Method
CompileDocument(String) Method
CompileDocument(String, DocumentCategory) Method
CompileDocument(String, DocumentCategory, DocumentContextCallback) Method
CompileDocument(String, V8CacheKind, Byte[]) Method
CompileDocument(String, DocumentCategory, V8CacheKind, Byte[]) Method
CompileDocument(String, V8CacheKind, Byte[], Boolean) Method
CompileDocument(String, V8CacheKind, Byte[], V8CacheResult) Method
CompileDocument(String, DocumentCategory, DocumentContextCallback, V8CacheKind, Byte[]) Method
CompileDocument(String, DocumentCategory, V8CacheKind, Byte[], Boolean) Method
CompileDocument(String, DocumentCategory, V8CacheKind, Byte[], V8CacheResult) Method
CompileDocument(String, DocumentCategory, DocumentContextCallback, V8CacheKind, Byte[], Boolean) Method
CompileDocument(String, DocumentCategory, DocumentContextCallback, V8CacheKind, Byte[], V8CacheResult) Method

# V8RuntimeCompileDocument(String, DocumentCategory, DocumentContextCallback, V8CacheKind, Byte, V8CacheResult) Method

Loads and compiles a document with the specified category and context callback, consuming previously generated cache data and updating it if necessary.
Namespace: Microsoft.ClearScript.V8
Assembly: ClearScript.V8 (in ClearScript.V8.dll) Version: 7.5.0
Syntax
C#
VB
C++
F#
Copy

    public V8Script CompileDocument(
    	string specifier,
    	DocumentCategory category,
    	DocumentContextCallback contextCallback,
    	V8CacheKind cacheKind,
    	ref byte[] cacheBytes,
    	out V8CacheResult cacheResult
    )

    Public Function CompileDocument (
    	specifier As String,
    	category As DocumentCategory,
    	contextCallback As DocumentContextCallback,
    	cacheKind As V8CacheKind,
    	ByRef cacheBytes As Byte(),
    	<OutAttribute> ByRef cacheResult As V8CacheResult
    ) As V8Script

    public:
    V8Script^ CompileDocument(
    	String^ specifier,
    	DocumentCategory^ category,
    	DocumentContextCallback^ contextCallback,
    	V8CacheKind cacheKind,
    	array<unsigned char>^% cacheBytes,
    	[OutAttribute] V8CacheResult% cacheResult
    )

    member CompileDocument :
            specifier : string *
            category : DocumentCategory *
            contextCallback : DocumentContextCallback *
            cacheKind : V8CacheKind *
            cacheBytes : byte[] byref *
            cacheResult : V8CacheResult byref -> V8Script

#### Parameters

specifier String
  A string specifying the document to be loaded and compiled.
category DocumentCategory
  An optional category for the requested document.
contextCallback DocumentContextCallback
  An optional context callback for the requested document.
cacheKind V8CacheKind
  The kind of cache data to be processed.
cacheBytes Byte
  Cache data for accelerated compilation.
cacheResult V8CacheResult
  The cache data processing result for the operation.

#### Return Value

V8Script
A compiled script that can be executed by multiple V8 script engine instances.
Remarks
To be accepted, the cache data must have been generated for identical script code by the same V8 build. If returned, the updated cache data can be stored externally and is usable in other V8 script engines and application processes.
See Also

#### Reference

V8Runtime Class
CompileDocument Overload
Microsoft.ClearScript.V8 Namespace

Copyright © Microsoft Corporation. All rights reserved.

Send comments on this topic to Microsoft