Skip to content

Commit 11fa6fa

Browse files
author
Wangsong Jin
committed
Update FrameProcessInfo.md
1 parent 9cb6da2 commit 11fa6fa

1 file changed

Lines changed: 17 additions & 15 deletions

File tree

specs/FrameProcesssInfo.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,8 @@ the frame running in this `CoreWebView2` or `CoreWebView2Frame`.
4141
* We propose extending `CoreWebView2FrameInfo` to include `FrameId`,
4242
`FrameKind` and `ParentFrameInfo` properties. `FrameId` is the same
4343
kind of ID as with `FrameID` in `CoreWebView2` and `CoreWebView2Frame`.
44-
`ParentFrameInfo` supports to retrive a frame's direct parent, ancestor
45-
first level frame and ancestor main frame. This also can be used to
46-
build the architecture of the frame tree with represent by `FrameInfo`.
44+
`ParentFrameInfo` supports to retrive a frame's direct parent. This
45+
also can be used to build the frame tree represented by `FrameInfo`s.
4746

4847
# Examples
4948
C++
@@ -310,7 +309,7 @@ private async void ProcessFrameInfoCmdExecuted(object target, ExecutedRoutedEven
310309
{
311310
try
312311
{
313-
// <GetProcessInfosWithDetailsAsync>
312+
// <GetProcessInfosWithDetails>
314313
IReadOnlyList<CoreWebView2ProcessInfo> processList = await webView.CoreWebView2.Environment.GetProcessInfosWithDetailsAsync();
315314
int processListCount = processList.Count;
316315
string rendererProcessInfosStr = $"{processListCount} process(es) found in total\n\n";
@@ -369,7 +368,7 @@ private async void ProcessFrameInfoCmdExecuted(object target, ExecutedRoutedEven
369368
otherProcessInfosStr += $"Process ID: {processId} | Process Kind: {kind}\n";
370369
}
371370
}
372-
// </GetProcessInfosWithDetailsAsync>
371+
// </GetProcessInfosWithDetails>
373372
string message = $"{rendererProcessCount} renderer process(es) found, {rendererProcessInfosStr + otherProcessInfosStr}";
374373
MessageBox.Show(this, message, "Process Info with Associated Frames");
375374
}
@@ -433,10 +432,10 @@ interface ICoreWebView2ProcessInfo2 : ICoreWebView2ProcessInfo {
433432
interface ICoreWebView2Environment14 : ICoreWebView2Environment13 {
434433
/// Gets a snapshot collection of `ProcessInfo`s corresponding to all currently
435434
/// running processes associated with this `CoreWebView2Environment` except
436-
/// for crashpad process. This provide the same list of `ProcessInfo`s as
437-
/// what's provided in `GetProcessInfos`. Plus, this provide a list of associated
438-
/// `FrameInfo`s which are actively running (showing UI elements) in the renderer
439-
/// process. Check `AssociatedFrameInfos` for acquiring this detail information.
435+
/// for crashpad process. This provides the same list of `ProcessInfo`s as
436+
/// what's provided in `GetProcessInfos`, but additionally provides a list of
437+
/// associated `FrameInfo`s which are actively running (showing UI elements)
438+
/// in the renderer process. See `AssociatedFrameInfos` for more information.
440439
///
441440
/// \snippet ProcessComponent.cpp GetProcessInfosWithDetails
442441
HRESULT GetProcessInfosWithDetails([in] ICoreWebView2GetProcessInfosWithDetailsCompletedHandler* handler);
@@ -445,8 +444,9 @@ interface ICoreWebView2Environment14 : ICoreWebView2Environment13 {
445444
/// A continuation of the ICoreWebView2FrameInfo interface.
446445
[uuid(a7a7e150-e2ca-11ed-b5ea-0242ac120002), object, pointer_default(unique)]
447446
interface ICoreWebView2FrameInfo2 : ICoreWebView2FrameInfo {
448-
/// The parent `FrameInfo`. `ParentFrameInfo` will only be populated when obtained
449-
/// via calling `CoreWebView2ProcessInfo.AssociatedFrameInfos`.
447+
/// This frame's parent frame's `FrameInfo`. `ParentFrameInfo` will only be
448+
/// populated when obtained via calling
449+
/// `CoreWebView2ProcessInfo.AssociatedFrameInfos`.
450450
/// `CoreWebView2FrameInfo` objects obtained via `CoreWebView2.ProcessFailed` will
451451
/// always have a `null` `ParentFrameInfo`. This property is also `null` for the
452452
/// top most document in the WebView2 which has no parent frame.
@@ -467,17 +467,19 @@ interface ICoreWebView2FrameInfo2 : ICoreWebView2FrameInfo {
467467
/// A continuation of the ICoreWebView2Frame4 interface.
468468
[uuid(04baa798-a0e9-11ed-a8fc-0242ac120002), object, pointer_default(unique)]
469469
interface ICoreWebView2Frame5: ICoreWebView2Frame4 {
470-
/// The unique identifier of the current frame.
470+
/// The unique identifier of the current frame. It's the same kind of ID as with
471+
/// the `FrameId` in `CoreWebView2` and via `CoreWebView2FrameInfo`.
471472
[propget] HRESULT FrameId([out, retval] UINT32* id);
472473
}
473474

474475
/// A continuation of the ICoreWebView2_17 interface.
475476
[uuid(ad712504-a66d-11ed-afa1-0242ac120002), object, pointer_default(unique)]
476477
interface ICoreWebView2_18 : ICoreWebView2_17 {
477-
/// The unique identifier of the current frame.
478-
/// Note that `FrameId` may not valid if `CoreWebView` has not done
478+
/// The unique identifier of the current frame. It's the same kind of ID as with
479+
/// the `FrameId` in `CoreWebView2Frame` and via `CoreWebView2FrameInfo`.
480+
/// Note that `FrameId` may not be valid if `CoreWebView` has not done
479481
/// any navigation. It's safe to get this value during or after the first
480-
/// `DOMContentLoaded` event. Else, it could return an invalid frame Id 0.
482+
/// `DOMContentLoaded` event. Otherwise, it could return the invalid frame Id 0.
481483
[propget] HRESULT FrameId([out, retval] UINT32* id);
482484
}
483485
```

0 commit comments

Comments
 (0)