# Interface ICefv8Value

Description
Hierarchy
Fields
Methods
Properties

## Unit

uCEFInterfaces

## Declaration

`type ICefv8Value = interface(ICefBaseRefCounted)`

## Description

Interface representing a V8 value handle. V8 handles can only be accessed from the thread on which they are created. Valid threads for creating a V8 handle include the render process main thread (TID_RENDERER) and WebWorker threads. A task runner for posting tasks on the associated thread can be retrieved via the ICefv8context.GetTaskRunner() function.

UNKNOWN

<see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_v8_capi.h">CEF source file: /include/capi/cef_v8_capi.h (cef_v8_value_t))

## Hierarchy

- IInterface
- ICefBaseRefCounted
- ICefv8Value

## Overview

### Methods

| `function IsValid: Boolean;`
| `function IsUndefined: Boolean;`
| `function IsNull: Boolean;`
| `function IsBool: Boolean;`
| `function IsInt: Boolean;`
| `function IsUInt: Boolean;`
| `function IsDouble: Boolean;`
| `function IsDate: Boolean;`
| `function IsString: Boolean;`
| `function IsObject: Boolean;`
| `function IsArray: Boolean;`
| `function IsArrayBuffer: Boolean;`
| `function IsFunction: Boolean;`
| `function IsPromise: Boolean;`
| `function IsSame(const that: ICefv8Value): Boolean;`
| `function GetBoolValue: Boolean;`
| `function GetIntValue: Integer;`
| `function GetUIntValue: Cardinal;`
| `function GetDoubleValue: Double;`
| `function GetDateValue: TDateTime;`
| `function GetStringValue: ustring;`
| `function IsUserCreated: Boolean;`
| `function HasException: Boolean;`
| `function GetException: ICefV8Exception;`
| `function ClearException: Boolean;`
| `function WillRethrowExceptions: Boolean;`
| `function SetRethrowExceptions(rethrow: Boolean): Boolean;`
| `function HasValueByKey(const key: ustring): Boolean;`
| `function HasValueByIndex(index: Integer): Boolean;`
| `function DeleteValueByKey(const key: ustring): Boolean;`
| `function DeleteValueByIndex(index: Integer): Boolean;`
| `function GetValueByKey(const key: ustring): ICefv8Value;`
| `function GetValueByIndex(index: Integer): ICefv8Value;`
| `function SetValueByKey(const key: ustring; const value: ICefv8Value; attribute: TCefV8PropertyAttributes): Boolean;`
| `function SetValueByIndex(index: Integer; const value: ICefv8Value): Boolean;`
| `function SetValueByAccessor(const key: ustring; attribute: TCefV8PropertyAttributes): Boolean;`
| `function GetKeys(const keys: TStrings): Integer;`
| `function SetUserData(const data: ICefCustomUserData): Boolean;`
| `function GetUserData: ICefCustomUserData;`
| `function GetExternallyAllocatedMemory: Integer;`
| `function AdjustExternallyAllocatedMemory(changeInBytes: Integer): Integer;`
| `function GetArrayLength: Integer;`
| `function GetArrayBufferReleaseCallback: ICefv8ArrayBufferReleaseCallback;`
| `function NeuterArrayBuffer: boolean;`
| `function GetArrayBufferByteLength: NativeUInt;`
| `function GetArrayBufferData: Pointer;`
| `function GetFunctionName: ustring;`
| `function GetFunctionHandler: ICefv8Handler;`
| `function ExecuteFunction(const obj: ICefv8Value; const arguments: TCefv8ValueArray): ICefv8Value;`
| `function ExecuteFunctionWithContext(const context: ICefv8Context; const obj: ICefv8Value; const arguments: TCefv8ValueArray): ICefv8Value;`
| `function ResolvePromise(const arg: ICefv8Value): boolean;`
| `function RejectPromise(const errorMsg: ustring): boolean;`

## Description

### Methods

| `function IsValid: Boolean;`

Returns true (1) if the underlying handle is valid and it can be accessed on the current thread. Do not call any other functions if this function returns false (0).

###### Attributes

GUID['{52319B8D-75A8-422C-BD4B-16FA08CC7F42}']

| `function IsUndefined: Boolean;`
True if the value type is undefined.

| `function IsNull: Boolean;`
True if the value type is null.

| `function IsBool: Boolean;`
True if the value type is bool.

| `function IsInt: Boolean;`
True if the value type is int.

| `function IsUInt: Boolean;`
True if the value type is unsigned int.

| `function IsDouble: Boolean;`
True if the value type is double.

| `function IsDate: Boolean;`
True if the value type is Date.

| `function IsString: Boolean;`
True if the value type is string.

| `function IsObject: Boolean;`
True if the value type is object.

| `function IsArray: Boolean;`
True if the value type is array.

| `function IsArrayBuffer: Boolean;`
True if the value type is an ArrayBuffer.

| `function IsFunction: Boolean;`
True if the value type is function.

| `function IsPromise: Boolean;`
True if the value type is a Promise.

| `function IsSame(const that: ICefv8Value): Boolean;`
Returns true (1) if this object is pointing to the same handle as |that| object.

| `function GetBoolValue: Boolean;`
Return a bool value.

| `function GetIntValue: Integer;`
Return an int value.

| `function GetUIntValue: Cardinal;`
Return an unsigned int value.

| `function GetDoubleValue: Double;`
Return a double value.

| `function GetDateValue: TDateTime;`
Return a Date value.

| `function GetStringValue: ustring;`
Return a string value.

| `function IsUserCreated: Boolean;`
Returns true (1) if this is a user created object.

| `function HasException: Boolean;`
Returns true (1) if the last function call resulted in an exception. This attribute exists only in the scope of the current CEF value object.

| `function GetException: ICefV8Exception;`
Returns the exception resulting from the last function call. This attribute exists only in the scope of the current CEF value object.

| `function ClearException: Boolean;`
Clears the last exception and returns true (1) on success.

| `function WillRethrowExceptions: Boolean;`
Returns true (1) if this object will re-throw future exceptions. This attribute exists only in the scope of the current CEF value object.

| `function SetRethrowExceptions(rethrow: Boolean): Boolean;`
Set whether this object will re-throw future exceptions. By default exceptions are not re-thrown. If a exception is re-thrown the current context should not be accessed again until after the exception has been caught and not re-thrown. Returns true (1) on success. This attribute exists only in the scope of the current CEF value object.

| `function HasValueByKey(const key: ustring): Boolean;`
Returns true (1) if the object has a value with the specified identifier.

| `function HasValueByIndex(index: Integer): Boolean;`
Returns true (1) if the object has a value with the specified identifier.

| `function DeleteValueByKey(const key: ustring): Boolean;`
Deletes the value with the specified identifier and returns true (1) on success. Returns false (0) if this function is called incorrectly or an exception is thrown. For read-only and don't-delete values this function will return true (1) even though deletion failed.

| `function DeleteValueByIndex(index: Integer): Boolean;`
Deletes the value with the specified identifier and returns true (1) on success. Returns false (0) if this function is called incorrectly, deletion fails or an exception is thrown. For read-only and don't-delete values this function will return true (1) even though deletion failed.

| `function GetValueByKey(const key: ustring): ICefv8Value;`
Returns the value with the specified identifier on success. Returns NULL if this function is called incorrectly or an exception is thrown.

| `function GetValueByIndex(index: Integer): ICefv8Value;`
Returns the value with the specified identifier on success. Returns NULL if this function is called incorrectly or an exception is thrown.

| `function SetValueByKey(const key: ustring; const value: ICefv8Value; attribute: TCefV8PropertyAttributes): Boolean;`
Associates a value with the specified identifier and returns true (1) on success. Returns false (0) if this function is called incorrectly or an exception is thrown. For read-only values this function will return true (1) even though assignment failed.

| `function SetValueByIndex(index: Integer; const value: ICefv8Value): Boolean;`
Associates a value with the specified identifier and returns true (1) on success. Returns false (0) if this function is called incorrectly or an exception is thrown. For read-only values this function will return true (1) even though assignment failed.

| `function SetValueByAccessor(const key: ustring; attribute: TCefV8PropertyAttributes): Boolean;`
Registers an identifier and returns true (1) on success. Access to the identifier will be forwarded to the ICefV8Accessor instance passed to cef_v8_value_create_object(). Returns false (0) if this function is called incorrectly or an exception is thrown. For read-only values this function will return true (1) even though assignment failed.

| `function GetKeys(const keys: TStrings): Integer;`
Read the keys for the object's values into the specified vector. Integer- based keys will also be returned as strings.

| `function SetUserData(const data: ICefCustomUserData): Boolean;`
Sets the user data for this object and returns true (1) on success. Returns false (0) if this function is called incorrectly. This function can only be called on user created objects.

| `function GetUserData: ICefCustomUserData;`
Returns the user data, if any, assigned to this object.

| `function GetExternallyAllocatedMemory: Integer;`
Returns the amount of externally allocated memory registered for the object.

| `function AdjustExternallyAllocatedMemory(changeInBytes: Integer): Integer;`

Adjusts the amount of registered external memory for the object. Used to give V8 an indication of the amount of externally allocated memory that is kept alive by JavaScript objects. V8 uses this information to decide when to perform global garbage collection. Each ICefv8Value tracks the amount of external memory associated with it and automatically decreases the global total by the appropriate amount on its destruction. |change_in_bytes| specifies the number of bytes to adjust by. This function returns the number of bytes associated with the object after the adjustment. This function can only be called on user created objects.

| `function GetArrayLength: Integer;`
Returns the number of elements in the array.

| `function GetArrayBufferReleaseCallback: ICefv8ArrayBufferReleaseCallback;`
Returns the ReleaseCallback object associated with the ArrayBuffer or NULL if the ArrayBuffer was not created with CreateArrayBuffer.

| `function NeuterArrayBuffer: boolean;`
Prevent the ArrayBuffer from using it's memory block by setting the length to zero. This operation cannot be undone. If the ArrayBuffer was created with CreateArrayBuffer then ICefv8ArrayBufferReleaseCallback.ReleaseBuffer will be called to release the underlying buffer.

| `function GetArrayBufferByteLength: NativeUInt;`
Returns the length (in bytes) of the ArrayBuffer.

| `function GetArrayBufferData: Pointer;`
Returns a pointer to the beginning of the memory block for this ArrayBuffer backing store. The returned pointer is valid as long as the ICefv8value is alive.

| `function GetFunctionName: ustring;`
Returns the function name.

| `function GetFunctionHandler: ICefv8Handler;`
Returns the function handler or NULL if not a CEF-created function.

| `function ExecuteFunction(const obj: ICefv8Value; const arguments: TCefv8ValueArray): ICefv8Value;`

Execute the function using the current V8 context. This function should only be called from within the scope of a ICefv8Handler or ICefV8Accessor callback, or in combination with calling enter() and exit() on a stored ICefv8Context reference. |object| is the receiver ('this' object) of the function. If |object| is NULL the current context's global object will be used. |arguments| is the list of arguments that will be passed to the function. Returns the function return value on success. Returns NULL if this function is called incorrectly or an exception is thrown.

| `function ExecuteFunctionWithContext(const context: ICefv8Context; const obj: ICefv8Value; const arguments: TCefv8ValueArray): ICefv8Value;`
Execute the function using the specified V8 context. |object| is the receiver ('this' object) of the function. If |object| is NULL the specified context's global object will be used. |arguments| is the list of arguments that will be passed to the function. Returns the function return value on success. Returns NULL if this function is called incorrectly or an exception is thrown.

| `function ResolvePromise(const arg: ICefv8Value): boolean;`

Resolve the Promise using the current V8 context. This function should only be called from within the scope of a ICefv8Handler or ICefV8Accessor callback, or in combination with calling enter() and exit() on a stored ICefv8Context reference. |arg| is the argument passed to the resolved promise. Returns true (1) on success. Returns false (0) if this function is called incorrectly or an exception is thrown.

| `function RejectPromise(const errorMsg: ustring): boolean;`
Reject the Promise using the current V8 context. This function should only be called from within the scope of a ICefv8Handler or ICefV8Accessor callback, or in combination with calling enter() and exit() on a stored ICefv8Context reference. Returns true (1) on success. Returns false (0) if this function is called incorrectly or an exception is thrown.

Generated by PasDoc 0.17.0.snapshot.