Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 2.93 KB

icorewebview2navigationcompletedeventargs.md

File metadata and controls

72 lines (49 loc) · 2.93 KB
Raw
description title ms.date keywords topic_type api_name api_type api_location
Event args for the `NavigationCompleted` event.
WebView2 Win32 C++ ICoreWebView2NavigationCompletedEventArgs
04/22/2024
IWebView2, IWebView2WebView, webview2, webview, win32 apps, win32, edge, ICoreWebView2, ICoreWebView2Controller, browser control, edge html, ICoreWebView2NavigationCompletedEventArgs
APIRef
ICoreWebView2NavigationCompletedEventArgs
ICoreWebView2NavigationCompletedEventArgs.get_IsSuccess
ICoreWebView2NavigationCompletedEventArgs.get_NavigationId
ICoreWebView2NavigationCompletedEventArgs.get_WebErrorStatus
COM
embeddedbrowserwebview.dll

interface ICoreWebView2NavigationCompletedEventArgs

[!INCLUDE deprecation-note]

interface ICoreWebView2NavigationCompletedEventArgs
  : public IUnknown

Event args for the NavigationCompleted event.

Summary

Members Descriptions
get_IsSuccess TRUE when the navigation is successful.
get_NavigationId The ID of the navigation.
get_WebErrorStatus The error code if the navigation failed.

Applies to

Product Introduced
WebView2 Win32 0.9.430
WebView2 Win32 Prerelease 0.9.488

Members

get_IsSuccess

TRUE when the navigation is successful.

public HRESULT get_IsSuccess(BOOL * isSuccess)

FALSE for a navigation that ended up in an error page (failures due to no network, DNS lookup failure, HTTP server responds with 4xx), but may also be FALSE for additional scenarios such as window.stop() run on navigated page. Note that WebView2 will report the navigation as 'unsuccessful' if the load for the navigation did not reach the expected completion for any reason. Such reasons include potentially catastrophic issues such network and certificate issues, but can also be the result of intended actions such as the app canceling a navigation or navigating away before the original navigation completed. Applications should not just rely on this flag, but also consider the reported WebErrorStatus to determine whether the failure is indeed catastrophic in their context. WebErrorStatuses that may indicate a non-catastrophic failure include:

  • COREWEBVIEW2_WEB_ERROR_STATUS_OPERATION_CANCELED

  • COREWEBVIEW2_WEB_ERROR_STATUS_VALID_AUTHENTICATION_CREDENTIALS_REQUIRED

  • COREWEBVIEW2_WEB_ERROR_STATUS_VALID_PROXY_AUTHENTICATION_REQUIRED

get_NavigationId

The ID of the navigation.

public HRESULT get_NavigationId(UINT64 * navigationId)

get_WebErrorStatus

The error code if the navigation failed.

public HRESULT get_WebErrorStatus(COREWEBVIEW2_WEB_ERROR_STATUS * webErrorStatus)