Skip to content

Commit 72a19b7

Browse files
author
Wangsong Jin
committed
Update FrameProcessInfo.md
1 parent bf09264 commit 72a19b7

1 file changed

Lines changed: 22 additions & 24 deletions

File tree

specs/FrameProcesssInfo.md

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,12 @@ In this document we describe the updated API. We'd appreciate your feedback.
2222

2323
# Description
2424
* We propose extending `CoreWebView2Environment` to include the
25-
`GetProcessInfosWithDetails` API. This asynchronous call returns the
26-
collection of all `ProcessInfo`s running in this `ICoreWebView2Environment`
27-
except for crashpad process. This provide the same list of `ProcessInfo`s as
28-
what's provided in `GetProcessInfos`. Plus, this also provide the list of
29-
associated `FrameInfo`s running in the renderer process. Note that instead
30-
of providing the real time of `ProcessInfo`s like `GetProcessInfos`, this
31-
provide a snapshot of all `ProcessInfo`s.
25+
`GetProcessInfosWithDetails` API. This asynchronous call returns a
26+
snapshot collection of `ProcessInfo`s corresponding to all currently
27+
running processes associated with this `ICoreWebView2Environment`
28+
except for crashpad process. This provide the same list of `ProcessInfo`s
29+
as what's provided in `GetProcessInfos`. Plus, this also provide the list
30+
of associated `FrameInfo`s running in the renderer process.
3231

3332
* We propose to add the `AssociatedFrameInfo` API to provide a list of
3433
`FrameInfo`s running in the asscociated renderer process.
@@ -377,7 +376,7 @@ interface ICoreWebView2ProcessInfo2 : ICoreWebView2ProcessInfo {
377376
/// Note that this is only available when the process `Kind` is
378377
/// `COREWEBVIEW2_PROCESS_KIND_RENDERER`
379378
/// and it's called from `ICoreWebView2GetProcessInfosWithDetailsCompletedHandler`.
380-
/// Else, it returns a HRESULT error code and `null` for `FrameInfo` list.
379+
/// Else, it returns an empty `FrameInfo` collection.
381380
///
382381
/// \snippet ProcessComponent.cpp AssociatedFrameInfos
383382
[propget] HRESULT AssociatedFrameInfos(
@@ -387,14 +386,12 @@ interface ICoreWebView2ProcessInfo2 : ICoreWebView2ProcessInfo {
387386
/// A continuation of the ICoreWebView2Environment13 interface.
388387
[uuid(9d4d8624-e2ca-11ed-b5ea-0242ac120002), object, pointer_default(unique)]
389388
interface ICoreWebView2Environment14 : ICoreWebView2Environment13 {
390-
/// Gets the collection of all `ProcessInfo`s running in this `ICoreWebView2Environment`
391-
/// except for crashpad process.
392-
/// This provide the same list of `ProcessInfo`s as what's provided in
393-
/// `GetProcessInfos`. Plus, this provide a list of associated `FrameInfo`s running in
394-
/// the renderer process. Check `AssociatedFrameInfos` for acquiring
395-
/// this detail infos.
396-
/// Note that instead of providing the real time of `ProcessInfo`s as
397-
/// `GetProcessInfos`, this provide a snapshot of all `ProcessInfo`s.
389+
/// Gets a snapshot collection of `ProcessInfo`s corresponding to all currently
390+
/// running processes associated with this `ICoreWebView2Environment` except
391+
/// for crashpad process. This provide the same list of `ProcessInfo`s as
392+
/// what's provided in `GetProcessInfos`. Plus, this provide a list of associated
393+
/// `FrameInfo`s running in the renderer process. Check `AssociatedFrameInfos`
394+
/// for acquiring this detail infos.
398395
///
399396
/// \snippet ProcessComponent.cpp GetProcessInfosWithDetails
400397
HRESULT GetProcessInfosWithDetails([in] ICoreWebView2GetProcessInfosWithDetailsCompletedHandler* handler);
@@ -403,17 +400,16 @@ interface ICoreWebView2Environment14 : ICoreWebView2Environment13 {
403400
/// A continuation of the ICoreWebView2FrameInfo interface.
404401
[uuid(a7a7e150-e2ca-11ed-b5ea-0242ac120002), object, pointer_default(unique)]
405402
interface ICoreWebView2FrameInfo2 : ICoreWebView2FrameInfo {
406-
/// The parent `FrameInfo`.
407-
/// This property is `null` for the top most document in the WebView2 which has
408-
/// no parent frame. Note that this is only available when it's called from
409-
/// `ICoreWebView2GetProcessInfosWithDetailsCompletedHandler`.
410-
/// Else, it return a HRESULT error code and `null` for parent `FrameInfo`.
403+
/// The parent `FrameInfo`. This property is `null` for the top most document in the
404+
/// WebView2 which has no parent frame. This is only available when it's called from
405+
/// `ICoreWebView2GetProcessInfosWithDetailsCompletedHandler`. Else, it returns `null`.
406+
/// Note that this parent frame info could be out of date as it's a snapshot.
411407
[propget] HRESULT ParentFrameInfo([out, retval] ICoreWebView2FrameInfo** frameInfo);
412408
/// The unique identifier of the frame associated with the current `FrameInfo`.
413409
/// It's the same kind of ID as with the frame ID in `ICoreWebView2` and
414-
/// `ICoreWebView2Frame`. Note that this is only available when it's called from
415-
/// `ICoreWebView2GetProcessInfosWithDetailsCompletedHandler`.
416-
/// Else, it return a HRESULT error codes and 0 for frame ID.
410+
/// `ICoreWebView2Frame`. This is only available when it's called from
411+
/// `ICoreWebView2GetProcessInfosWithDetailsCompletedHandler`. Else, it returns `null`.
412+
/// Note that this frame Id could be out of date as it's a snapshot.
417413
[propget] HRESULT FrameId([out, retval] UINT32* id);
418414
}
419415

@@ -428,6 +424,8 @@ interface ICoreWebView2Frame5: ICoreWebView2Frame4 {
428424
[uuid(ad712504-a66d-11ed-afa1-0242ac120002), object, pointer_default(unique)]
429425
interface ICoreWebView2_18 : ICoreWebView2_17 {
430426
/// The unique identifier of the current frame.
427+
/// Note that frame Id is not valid if `ICoreWebView` has not started
428+
/// a navigation. It returns an error code `E_FAIL`.
431429
[propget] HRESULT FrameId([out, retval] UINT32* id);
432430
}
433431
```

0 commit comments

Comments
 (0)