@@ -84,6 +84,9 @@ Freezing is similar to putting a tab to sleep in the Edge browser. Freezing paus
8484WebView script timers and animations, minimizes CPU usage for the associated
8585browser renderer process and allows the operating system to reuse the memory that was
8686used by the renderer process for other processes.
87+ Note that the freeze is best effort and considered completed successfully once the request
88+ is sent to browser renderer process. If there is a running script, the script will continue
89+ to run and the renderer process will be frozen after that script is done.
8790See [Sleeping Tabs FAQ](https://techcommunity.microsoft.com/t5/articles/sleeping-tabs-faq/m-p/1705434)
8891for conditions that might prevent WebView from being frozen. In those situations,
8992The TryFreeze operation will fail and the completed handler will be invoked with isSuccessful as false.
@@ -105,14 +108,17 @@ interface ICoreWebView2_2 : ICoreWebView2 {
105108 /// Platform app is suspended, during the suspended event handler before completing
106109 /// the suspended event.
107110 /// The CoreWebView2Controller must be invisible when the API is called. Otherwise, the
108- /// API fails with `HRESULT_FROM_WIN32(ERROR_INVALID_STATE)`.
111+ /// API fails with `HRESULT_FROM_WIN32(ERROR_INVALID_STATE)`.
109112 /// Freezing is similar to putting a tab to sleep in the Edge browser. Freezing pauses
110113 /// WebView script timers and animations, minimizes CPU usage for the associated
111114 /// browser renderer process and allows the operating system to reuse the memory that was
112- /// used by the renderer process for other processes.
115+ /// used by the renderer process for other processes.
116+ /// Note that the freeze is best effort and considered completed successfully once the request
117+ /// is sent to browser renderer process. If there is a running script, the script will continue
118+ /// to run and the renderer process will be frozen after that script is done.
113119 /// See [Sleeping Tabs FAQ](https://techcommunity.microsoft.com/t5/articles/sleeping-tabs-faq/m-p/1705434)
114120 /// for conditions that might prevent WebView from being frozen. In those situations,
115- /// The TryFreeze operation will fail and the completed handler will be invoked with isSuccessful as false.
121+ /// The TryFreeze operation will fail and the completed handler will be invoked with isSuccessful as false.
116122 /// The WebView will be automatically unfrozen when it becomes visible. Therefore, the
117123 /// app normally doesn't have to call Unfreeze.
118124 /// The app can call `Unfreeze` and then `TryFreeze` periodically for an invisibile WebView so that
0 commit comments