# Interface ICefDictionaryValue

Description
Hierarchy
Fields
Methods
Properties

## Unit

uCEFInterfaces

## Declaration

`type ICefDictionaryValue = interface(ICefBaseRefCounted)`

## Description

Interface representing a dictionary 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_dictionary_value_t))

## Hierarchy

- IInterface
- ICefBaseRefCounted
- ICefDictionaryValue

## Overview

### Methods

| `function IsValid: Boolean;`
| `function isOwned: Boolean;`
| `function IsReadOnly: Boolean;`
| `function IsSame(const that: ICefDictionaryValue): Boolean;`
| `function IsEqual(const that: ICefDictionaryValue): Boolean;`
| `function Copy(excludeEmptyChildren: Boolean): ICefDictionaryValue;`
| `function GetSize: NativeUInt;`
| `function Clear: Boolean;`
| `function HasKey(const key: ustring): Boolean;`
| `function GetKeys(const keys: TStrings): Boolean;`
| `function Remove(const key: ustring): Boolean;`
| `function GetType(const key: ustring): TCefValueType;`
| `function GetValue(const key: ustring): ICefValue;`
| `function GetBool(const key: ustring): Boolean;`
| `function GetInt(const key: ustring): Integer;`
| `function GetDouble(const key: ustring): Double;`
| `function GetString(const key: ustring): ustring;`
| `function GetBinary(const key: ustring): ICefBinaryValue;`
| `function GetDictionary(const key: ustring): ICefDictionaryValue;`
| `function GetList(const key: ustring): ICefListValue;`
| `function SetValue(const key: ustring; const value: ICefValue): Boolean;`
| `function SetNull(const key: ustring): Boolean;`
| `function SetBool(const key: ustring; value: Boolean): Boolean;`
| `function SetInt(const key: ustring; value: Integer): Boolean;`
| `function SetDouble(const key: ustring; value: Double): Boolean;`
| `function SetString(const key, value: ustring): Boolean;`
| `function SetBinary(const key: ustring; const value: ICefBinaryValue): Boolean;`
| `function SetDictionary(const key: ustring; const value: ICefDictionaryValue): Boolean;`
| `function SetList(const key: ustring; 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['{B9638559-54DC-498C-8185-233EEF12BC69}']

| `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: ICefDictionaryValue): 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: ICefDictionaryValue): Boolean;`
Returns true (1) if this object and |that| object have an equivalent underlying value but are not necessarily the same object.

| `function Copy(excludeEmptyChildren: Boolean): ICefDictionaryValue;`
Returns a writable copy of this object. If |exclude_NULL_children| is true (1) any NULL dictionaries or lists will be excluded from the copy.

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

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

| `function HasKey(const key: ustring): Boolean;`
Returns true (1) if the current dictionary has a value for the given key.

| `function GetKeys(const keys: TStrings): Boolean;`
Reads all keys for this dictionary into the specified vector.

| `function Remove(const key: ustring): Boolean;`
Removes the value at the specified key. Returns true (1) is the value was removed successfully.

| `function GetType(const key: ustring): TCefValueType;`
Returns the value type for the specified key.

| `function GetValue(const key: ustring): ICefValue;`
Returns the value at the specified key. 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(const key: ustring): Boolean;`
Returns the value at the specified key as type bool.

| `function GetInt(const key: ustring): Integer;`
Returns the value at the specified key as type int.

| `function GetDouble(const key: ustring): Double;`
Returns the value at the specified key as type double.

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

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

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

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

| `function SetValue(const key: ustring; const value: ICefValue): Boolean;`
Sets the value at the specified key. 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(const key: ustring): Boolean;`
Sets the value at the specified key as type null. Returns true (1) if the value was set successfully.

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

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

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

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

| `function SetBinary(const key: ustring; const value: ICefBinaryValue): Boolean;`
Sets the value at the specified key 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(const key: ustring; const value: ICefDictionaryValue): Boolean;`
Sets the value at the specified key 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(const key: ustring; const value: ICefListValue): Boolean;`
Sets the value at the specified key 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.17.0.snapshot.