# Interface ICefListValue

Description
Hierarchy
Fields
Methods
Properties

## Unit

uCEFInterfaces

## Declaration

`type ICefListValue = interface(ICefBaseRefCounted)`

## Description

Interface representing a list value. Can be used on any process and thread.

UNKNOWN

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

## Hierarchy

- IInterface
- ICefBaseRefCounted
- ICefListValue

## Overview

### Methods

| `function IsValid: Boolean;`
| `function IsOwned: Boolean;`
| `function IsReadOnly: Boolean;`
| `function IsSame(const that: ICefListValue): Boolean;`
| `function IsEqual(const that: ICefListValue): Boolean;`
| `function Copy: ICefListValue;`
| `function SetSize(size: NativeUInt): Boolean;`
| `function GetSize: NativeUInt;`
| `function Clear: Boolean;`
| `function Remove(index: NativeUInt): Boolean;`
| `function GetType(index: NativeUInt): TCefValueType;`
| `function GetValue(index: NativeUInt): ICefValue;`
| `function GetBool(index: NativeUInt): Boolean;`
| `function GetInt(index: NativeUInt): Integer;`
| `function GetDouble(index: NativeUInt): Double;`
| `function GetString(index: NativeUInt): ustring;`
| `function GetBinary(index: NativeUInt): ICefBinaryValue;`
| `function GetDictionary(index: NativeUInt): ICefDictionaryValue;`
| `function GetList(index: NativeUInt): ICefListValue;`
| `function SetValue(index: NativeUInt; const value: ICefValue): Boolean;`
| `function SetNull(index: NativeUInt): Boolean;`
| `function SetBool(index: NativeUInt; value: Boolean): Boolean;`
| `function SetInt(index: NativeUInt; value: Integer): Boolean;`
| `function SetDouble(index: NativeUInt; value: Double): Boolean;`
| `function SetString(index: NativeUInt; const value: ustring): Boolean;`
| `function SetBinary(index: NativeUInt; const value: ICefBinaryValue): Boolean;`
| `function SetDictionary(index: NativeUInt; const value: ICefDictionaryValue): Boolean;`
| `function SetList(index: NativeUInt; const value: ICefListValue): Boolean;`

## Description

### Methods

| `function IsValid: Boolean;`
Returns true (1) if this object is valid. This object may become invalid if the underlying data is owned by another object (e.g. list or dictionary) and that other object is then modified or destroyed. Do not call any other functions if this function returns false (0). ###### Attributes GUID['{09174B9D-0CC6-4360-BBB0-3CC0117F70F6}']

| `function IsOwned: Boolean;`
Returns true (1) if this object is currently owned by another object.

| `function IsReadOnly: Boolean;`
Returns true (1) if the values of this object are read-only. Some APIs may expose read-only objects.

| `function IsSame(const that: ICefListValue): Boolean;`
Returns true (1) if this object and |that| object have the same underlying data. If true (1) modifications to this object will also affect |that| object and vice-versa.

| `function IsEqual(const that: ICefListValue): Boolean;`
Returns true (1) if this object and |that| object have an equivalent underlying value but are not necessarily the same object.

| `function Copy: ICefListValue;`
Returns a writable copy of this object.

| `function SetSize(size: NativeUInt): Boolean;`
Sets the number of values. If the number of values is expanded all new value slots will default to type null. Returns true (1) on success.

| `function GetSize: NativeUInt;`
Returns the number of values.

| `function Clear: Boolean;`
Removes all values. Returns true (1) on success.

| `function Remove(index: NativeUInt): Boolean;`
Removes the value at the specified index.

| `function GetType(index: NativeUInt): TCefValueType;`
Returns the value type at the specified index.

| `function GetValue(index: NativeUInt): ICefValue;`
Returns the value at the specified index. For simple types the returned value will copy existing data and modifications to the value will not modify this object. For complex types (binary, dictionary and list) the returned value will reference existing data and modifications to the value will modify this object.

| `function GetBool(index: NativeUInt): Boolean;`
Returns the value at the specified index as type bool.

| `function GetInt(index: NativeUInt): Integer;`
Returns the value at the specified index as type int.

| `function GetDouble(index: NativeUInt): Double;`
Returns the value at the specified index as type double.

| `function GetString(index: NativeUInt): ustring;`
Returns the value at the specified index as type string.

| `function GetBinary(index: NativeUInt): ICefBinaryValue;`
Returns the value at the specified index as type binary. The returned value will reference existing data.

| `function GetDictionary(index: NativeUInt): ICefDictionaryValue;`
Returns the value at the specified index as type dictionary. The returned value will reference existing data and modifications to the value will modify this object.

| `function GetList(index: NativeUInt): ICefListValue;`
Returns the value at the specified index as type list. The returned value will reference existing data and modifications to the value will modify this object.

| `function SetValue(index: NativeUInt; const value: ICefValue): Boolean;`
Sets the value at the specified index. Returns true (1) if the value was set successfully. If |value| represents simple data then the underlying data will be copied and modifications to |value| will not modify this object. If |value| represents complex data (binary, dictionary or list) then the underlying data will be referenced and modifications to |value| will modify this object.

| `function SetNull(index: NativeUInt): Boolean;`
Sets the value at the specified index as type null. Returns true (1) if the value was set successfully.

| `function SetBool(index: NativeUInt; value: Boolean): Boolean;`
Sets the value at the specified index as type bool. Returns true (1) if the value was set successfully.

| `function SetInt(index: NativeUInt; value: Integer): Boolean;`
Sets the value at the specified index as type int. Returns true (1) if the value was set successfully.

| `function SetDouble(index: NativeUInt; value: Double): Boolean;`
Sets the value at the specified index as type double. Returns true (1) if the value was set successfully.

| `function SetString(index: NativeUInt; const value: ustring): Boolean;`
Sets the value at the specified index as type string. Returns true (1) if the value was set successfully.

| `function SetBinary(index: NativeUInt; const value: ICefBinaryValue): Boolean;`
Sets the value at the specified index as type binary. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.

| `function SetDictionary(index: NativeUInt; const value: ICefDictionaryValue): Boolean;`
Sets the value at the specified index as type dict. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.

| `function SetList(index: NativeUInt; const value: ICefListValue): Boolean;`
Sets the value at the specified index as type list. Returns true (1) if the value was set successfully. If |value| is currently owned by another object then the value will be copied and the |value| reference will not change. Otherwise, ownership will be transferred to this object and the |value| reference will be invalidated.

Generated by PasDoc 0.16.0-snapshot.