Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

(default)
Struct _cef_settings_t

   in cef_types.h

struct _cef_settings_t

Initialization settings. Specify NULL or 0 to get the recommended default values. Many of these and other settings can also configured using command- line switches.


Field Summary
 cef_string_t accept_language_list
          Comma delimited ordered list of language codes without any whitespace that will be used in the "Accept-Language" HTTP header.
 cef_string_t application_client_id_for_file_scanning
          GUID string used for identifying the application.
 cef_color_t background_color
          Background color used for the browser before a document is loaded and when no document color is specified.
 cef_string_t browser_subprocess_path
          The path to a separate executable that will be launched for sub-processes.
 cef_string_t cache_path
          The location where data for the global browser cache will be stored on disk.
 int command_line_args_disabled
          Set to true (1) to disable configuration of browser process features using standard CEF and Chromium command-line arguments.
 int enable_net_security_expiration
          Set to true (1) to enable date-based expiration of built in network security information (i.e. certificate transparency logs, HSTS preloading and pinning information).
 int external_message_pump
          Set to true (1) to control browser process main (UI) thread message pump scheduling via the CefBrowserProcessHandler::OnScheduleMessagePumpWork() callback.
 cef_string_t framework_dir_path
          The path to the CEF framework directory on macOS.
 int ignore_certificate_errors
          Set to true (1) to ignore errors related to invalid SSL certificates.
 cef_string_t javascript_flags
          Custom flags that will be used when initializing the V8 JavaScript engine.
 cef_string_t locale
          The locale string that will be passed to WebKit.
 cef_string_t locales_dir_path
          The fully qualified path for the locales directory.
 cef_string_t log_file
          The directory and file name to use for the debug log.
 cef_log_severity_t log_severity
          The log severity.
 int multi_threaded_message_loop
          Set to true (1) to have the browser process message loop run in a separate thread.
 int no_sandbox
          Set to true (1) to disable the sandbox for sub-processes.
 int pack_loading_disabled
          Set to true (1) to disable loading of pack files for resources and locales.
 int persist_session_cookies
          To persist session cookies (cookies without an expiry date or validity interval) by default when using the global cookie manager set this value to true (1).
 int persist_user_preferences
          To persist user preferences as a JSON file in the cache path directory set this value to true (1).
 cef_string_t product_version
          Value that will be inserted as the product portion of the default User-Agent string.
 int remote_debugging_port
          Set to a value between 1024 and 65535 to enable remote debugging on the specified port.
 cef_string_t resources_dir_path
          The fully qualified path for the resources directory.
 cef_string_t root_cache_path
          The root directory that all CefSettings.
 size_t size
          Size of this structure.
 int uncaught_exception_stack_size
          The number of stack trace frames to capture for uncaught exceptions.
 cef_string_t user_agent
          Value that will be returned as the User-Agent HTTP header.
 cef_string_t user_data_path
          The location where user data such as spell checking dictionary files will be stored on disk.
 int windowless_rendering_enabled
          Set to true (1) to enable windowless (off-screen) rendering support.
 

Field Detail

accept_language_list

public cef_string_t accept_language_list;
Comma delimited ordered list of language codes without any whitespace that will be used in the "Accept-Language" HTTP header. May be overridden on a per-browser basis using the CefBrowserSettings.accept_language_list value. If both values are empty then "en-US,en" will be used. Can be overridden for individual CefRequestContext instances via the CefRequestContextSettings.accept_language_list value.

application_client_id_for_file_scanning

public cef_string_t application_client_id_for_file_scanning;
GUID string used for identifying the application. This is passed to the system AV function for scanning downloaded files. By default, the GUID will be an empty string and the file will be treated as an untrusted file when the GUID is empty.

background_color

public cef_color_t background_color;
Background color used for the browser before a document is loaded and when no document color is specified. The alpha component must be either fully opaque (0xFF) or fully transparent (0x00). If the alpha component is fully opaque then the RGB components will be used as the background color. If the alpha component is fully transparent for a windowed browser then the default value of opaque white be used. If the alpha component is fully transparent for a windowless (off-screen) browser then transparent painting will be enabled.

browser_subprocess_path

public cef_string_t browser_subprocess_path;
The path to a separate executable that will be launched for sub-processes. If this value is empty on Windows or Linux then the main process executable will be used. If this value is empty on macOS then a helper executable must exist at "Contents/Frameworks/ Helper.app/Contents/MacOS/ Helper" in the top-level app bundle. See the comments on CefExecuteProcess() for details. Also configurable using the "browser-subprocess-path" command-line switch.

cache_path

public cef_string_t cache_path;
The location where data for the global browser cache will be stored on disk. In non-empty this must be either equal to or a child directory of CefSettings.root_cache_path. If empty then browsers will be created in "incognito mode" where in-memory caches are used for storage and no data is persisted to disk. HTML5 databases such as localStorage will only persist across sessions if a cache path is specified. Can be overridden for individual CefRequestContext instances via the CefRequestContextSettings.cache_path value.

command_line_args_disabled

public int command_line_args_disabled;
Set to true (1) to disable configuration of browser process features using standard CEF and Chromium command-line arguments. Configuration can still be specified using CEF data structures or via the CefApp::OnBeforeCommandLineProcessing() method.

enable_net_security_expiration

public int enable_net_security_expiration;
Set to true (1) to enable date-based expiration of built in network security information (i.e. certificate transparency logs, HSTS preloading and pinning information). Enabling this option improves network security but may cause HTTPS load failures when using CEF binaries built more than 10 weeks in the past. See https://www.certificate-transparency.org/ and https://www.chromium.org/hsts for details. Also configurable using the "enable-net-security-expiration" command-line switch. Can be overridden for individual CefRequestContext instances via the CefRequestContextSettings.enable_net_security_expiration value.

external_message_pump

public int external_message_pump;
Set to true (1) to control browser process main (UI) thread message pump scheduling via the CefBrowserProcessHandler::OnScheduleMessagePumpWork() callback. This option is recommended for use in combination with the CefDoMessageLoopWork() function in cases where the CEF message loop must be integrated into an existing application message loop (see additional comments and warnings on CefDoMessageLoopWork). Enabling this option is not recommended for most users; leave this option disabled and use either the CefRunMessageLoop() function or multi_threaded_message_loop if possible.

framework_dir_path

public cef_string_t framework_dir_path;
The path to the CEF framework directory on macOS. If this value is empty then the framework must exist at "Contents/Frameworks/Chromium Embedded Framework.framework" in the top-level app bundle. Also configurable using the "framework-dir-path" command-line switch.

ignore_certificate_errors

public int ignore_certificate_errors;
Set to true (1) to ignore errors related to invalid SSL certificates. Enabling this setting can lead to potential security vulnerabilities like "man in the middle" attacks. Applications that load content from the internet should not enable this setting. Also configurable using the "ignore-certificate-errors" command-line switch. Can be overridden for individual CefRequestContext instances via the CefRequestContextSettings.ignore_certificate_errors value.

javascript_flags

public cef_string_t javascript_flags;
Custom flags that will be used when initializing the V8 JavaScript engine. The consequences of using custom flags may not be well tested. Also configurable using the "js-flags" command-line switch.

locale

public cef_string_t locale;
The locale string that will be passed to WebKit. If empty the default locale of "en-US" will be used. This value is ignored on Linux where locale is determined using environment variable parsing with the precedence order: LANGUAGE, LC_ALL, LC_MESSAGES and LANG. Also configurable using the "lang" command-line switch.

locales_dir_path

public cef_string_t locales_dir_path;
The fully qualified path for the locales directory. If this value is empty the locales directory must be located in the module directory. This value is ignored on Mac OS X where pack files are always loaded from the app bundle Resources directory. Also configurable using the "locales-dir-path" command-line switch.

log_file

public cef_string_t log_file;
The directory and file name to use for the debug log. If empty a default log file name and location will be used. On Windows and Linux a "debug.log" file will be written in the main executable directory. On Mac OS X a "~/Library/Logs/_debug.log" file will be written where is the name of the main app executable. Also configurable using the "log-file" command-line switch.

log_severity

public cef_log_severity_t log_severity;
The log severity. Only messages of this severity level or higher will be logged. When set to DISABLE no messages will be written to the log file, but FATAL messages will still be output to stderr. Also configurable using the "log-severity" command-line switch with a value of "verbose", "info", "warning", "error", "fatal" or "disable".

multi_threaded_message_loop

public int multi_threaded_message_loop;
Set to true (1) to have the browser process message loop run in a separate thread. If false (0) than the CefDoMessageLoopWork() function must be called from your application message loop. This option is only supported on Windows and Linux.

no_sandbox

public int no_sandbox;
Set to true (1) to disable the sandbox for sub-processes. See cef_sandbox_win.h for requirements to enable the sandbox on Windows. Also configurable using the "no-sandbox" command-line switch.

pack_loading_disabled

public int pack_loading_disabled;
Set to true (1) to disable loading of pack files for resources and locales. A resource bundle handler must be provided for the browser and render processes via CefApp::GetResourceBundleHandler() if loading of pack files is disabled. Also configurable using the "disable-pack-loading" command- line switch.

persist_session_cookies

public int persist_session_cookies;
To persist session cookies (cookies without an expiry date or validity interval) by default when using the global cookie manager set this value to true (1). Session cookies are generally intended to be transient and most Web browsers do not persist them. A |cache_path| value must also be specified to enable this feature. Also configurable using the "persist-session-cookies" command-line switch. Can be overridden for individual CefRequestContext instances via the CefRequestContextSettings.persist_session_cookies value.

persist_user_preferences

public int persist_user_preferences;
To persist user preferences as a JSON file in the cache path directory set this value to true (1). A |cache_path| value must also be specified to enable this feature. Also configurable using the "persist-user-preferences" command-line switch. Can be overridden for individual CefRequestContext instances via the CefRequestContextSettings.persist_user_preferences value.

product_version

public cef_string_t product_version;
Value that will be inserted as the product portion of the default User-Agent string. If empty the Chromium product version will be used. If |userAgent| is specified this value will be ignored. Also configurable using the "product-version" command-line switch.

remote_debugging_port

public int remote_debugging_port;
Set to a value between 1024 and 65535 to enable remote debugging on the specified port. For example, if 8080 is specified the remote debugging URL will be http://localhost:8080. CEF can be remotely debugged from any CEF or Chrome browser window. Also configurable using the "remote-debugging-port" command-line switch.

resources_dir_path

public cef_string_t resources_dir_path;
The fully qualified path for the resources directory. If this value is empty the cef.pak and/or devtools_resources.pak files must be located in the module directory on Windows/Linux or the app bundle Resources directory on Mac OS X. Also configurable using the "resources-dir-path" command-line switch.

root_cache_path

public cef_string_t root_cache_path;
The root directory that all CefSettings.cache_path and CefRequestContextSettings.cache_path values must have in common. If this value is empty and CefSettings.cache_path is non-empty then this value will default to the CefSettings.cache_path value. Failure to set this value correctly may result in the sandbox blocking read/write access to the cache_path directory.

size

public size_t size;
Size of this structure.

uncaught_exception_stack_size

public int uncaught_exception_stack_size;
The number of stack trace frames to capture for uncaught exceptions. Specify a positive value to enable the CefRenderProcessHandler:: OnUncaughtException() callback. Specify 0 (default value) and OnUncaughtException() will not be called. Also configurable using the "uncaught-exception-stack-size" command-line switch.

user_agent

public cef_string_t user_agent;
Value that will be returned as the User-Agent HTTP header. If empty the default User-Agent string will be used. Also configurable using the "user-agent" command-line switch.

user_data_path

public cef_string_t user_data_path;
The location where user data such as spell checking dictionary files will be stored on disk. If empty then the default platform-specific user data directory will be used ("~/.cef_user_data" directory on Linux, "~/Library/Application Support/CEF/User Data" directory on Mac OS X, "Local Settings\Application Data\CEF\User Data" directory under the user profile directory on Windows).

windowless_rendering_enabled

public int windowless_rendering_enabled;
Set to true (1) to enable windowless (off-screen) rendering support. Do not enable this value if the application does not use windowless rendering as it may reduce rendering performance on some systems.

 Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

Chromium Embedded Framework (CEF) Copyright © 2016 Marshall A. Greenblatt