ICoreWebView2BrowserExtension

Undocumented in source.

Members

Functions

Enable
HRESULT Enable(BOOL isEnabled, ICoreWebView2BrowserExtensionEnableCompletedHandler handler)

Sets whether this browser extension is enabled or disabled. This change applies immediately to the extension in all HTML documents in all WebView2s associated with this profile. After an extension is removed, calling Enable will not change the value of IsEnabled.

Remove
HRESULT Remove(ICoreWebView2BrowserExtensionRemoveCompletedHandler handler)

Removes this browser extension from its WebView2 Profile. The browser extension is removed immediately including from all currently running HTML documents associated with this WebView2 Profile. The removal is persisted and future uses of this profile will not have this extension installed. After an extension is removed, calling Remove again will cause an exception.

get_Id
HRESULT get_Id(LPWSTR* value)

This is the browser extension's ID. This is the same browser extension ID returned by the browser extension API `chrome.runtime.id`. Please see that documentation for more details on how the ID is generated. After an extension is removed, calling Id will return the id of the extension that is removed. The caller must free the returned string with CoTaskMemFree. See API Conventions.

get_IsEnabled
HRESULT get_IsEnabled(BOOL* value)

If isEnabled is true then the Extension is enabled and running in WebView instances. If it is false then the Extension is disabled and not running in WebView instances. When a Extension is first installed, IsEnable are default to be TRUE. isEnabled is persisted per profile. After an extension is removed, calling isEnabled will return the value at the time it was removed.

get_Name
HRESULT get_Name(LPWSTR* value)

This is the browser extension's name. This value is defined in this browser extension's manifest.json file. If manifest.json define extension's localized name, this value will be the localized version of the name. Please see Manifest.json name for more details. After an extension is removed, calling Name will return the name of the extension that is removed. The caller must free the returned string with CoTaskMemFree. See API Conventions.

Meta