Share via

interface ICoreWebView2ExecuteScriptResult

  • Article

Note

This reference is no longer being maintained. For the latest API reference, see WebView2 API Reference.

interface ICoreWebView2ExecuteScriptResult
  : public IUnknown

This is the result for ExecuteScriptWithResult.

Summary

Members Descriptions
get_Exception If Succeeded is false, you can use this property to get the unhandled exception thrown by script execution Note that due to the compatibility of the WinRT/.NET interface, S_OK will be returned even if the acquisition fails.
get_ResultAsJson A function that has no explicit return value returns undefined.
get_Succeeded This property is true if ExecuteScriptWithResult successfully executed script with no unhandled exceptions and the result is available in the ResultAsJson property or via the TryGetResultAsString method.
TryGetResultAsString If Succeeded is true and the result of script execution is a string, this method provides the value of the string result, and we will get the FALSE var value when the js result is not string type.

Applies to

Product Introduced
WebView2 Win32 1.0.2277.86
WebView2 Win32 Prerelease

Members

get_Exception

If Succeeded is false, you can use this property to get the unhandled exception thrown by script execution Note that due to the compatibility of the WinRT/.NET interface, S_OK will be returned even if the acquisition fails.

public HRESULT get_Exception(ICoreWebView2ScriptException ** exception)

We can determine whether the acquisition is successful by judging whether the exception is nullptr.

get_ResultAsJson

A function that has no explicit return value returns undefined.

public HRESULT get_ResultAsJson(LPWSTR * jsonResult)

If the script that was run throws an unhandled exception, then the result is also "null". This method is applied asynchronously. If the method is run before ContentLoading, the script will not be executed and the string "null" will be returned. The return value description is as follows

  1. S_OK: Execution succeeds.

  2. E_POINTER: When the jsonResult is nullptr.

get_Succeeded

This property is true if ExecuteScriptWithResult successfully executed script with no unhandled exceptions and the result is available in the ResultAsJson property or via the TryGetResultAsString method.

public HRESULT get_Succeeded(BOOL * value)

If it is false then the script execution had an unhandled exception which you can get via the Exception property.

TryGetResultAsString

If Succeeded is true and the result of script execution is a string, this method provides the value of the string result, and we will get the FALSE var value when the js result is not string type.

public HRESULT TryGetResultAsString(LPWSTR * stringResult, BOOL * value)

The return value description is as follows

  1. S_OK: Execution succeeds.

  2. E_POINTER: When the stringResult or value is nullptr. NOTE: If the value returns FALSE, the stringResult will be set to a empty string.