interface ICoreWebView2FrameInfo2
Note
This reference is no longer being maintained. For the latest API reference, see WebView2 API Reference.
interface ICoreWebView2FrameInfo2
: public ICoreWebView2FrameInfo
A continuation of the ICoreWebView2FrameInfo interface that provides ParentFrameInfo, FrameId and FrameKind properties.
Summary
| Members | Descriptions |
|---|---|
| get_FrameId | The unique identifier of the frame associated with the current FrameInfo. |
| get_FrameKind | The frame kind of the frame. |
| get_ParentFrameInfo | This parent frame's FrameInfo. |
Applies to
| Product | Introduced |
|---|---|
| WebView2 Win32 | 1.0.2210.55 |
| WebView2 Win32 Prerelease | 1.0.2357 |
Members
get_FrameId
The unique identifier of the frame associated with the current FrameInfo.
public HRESULT get_FrameId(UINT32 * id)
It's the same kind of ID as with the FrameId in CoreWebView2 and via CoreWebView2Frame. FrameId will only be populated (non-zero) when obtained calling CoreWebView2ProcessExtendedInfo.AssociatedFrameInfos. CoreWebView2FrameInfo objects obtained via CoreWebView2.ProcessFailed will always have an invalid frame Id 0. Note that this FrameId could be out of date as it's a snapshot. If there's WebView2 created or destroyed or FrameCreated/FrameDestroyed events after the asynchronous call CoreWebView2Environment.GetProcessExtendedInfos starts, you may want to call asynchronous method again to get the updated FrameInfos.
get_FrameKind
The frame kind of the frame.
public HRESULT get_FrameKind(COREWEBVIEW2_FRAME_KIND * kind)
FrameKind will only be populated when obtained calling CoreWebView2ProcessExtendedInfo.AssociatedFrameInfos. CoreWebView2FrameInfo objects obtained via CoreWebView2.ProcessFailed will always have the default value COREWEBVIEW2_FRAME_KIND_UNKNOWN. Note that this FrameKind could be out of date as it's a snapshot.
get_ParentFrameInfo
This parent frame's FrameInfo.
public HRESULT get_ParentFrameInfo(ICoreWebView2FrameInfo ** frameInfo)
ParentFrameInfo will only be populated when obtained via calling CoreWebView2ProcessExtendedInfo.AssociatedFrameInfos. CoreWebView2FrameInfo objects obtained via CoreWebView2.ProcessFailed will always have a null ParentFrameInfo. This property is also null for the main frame in the WebView2 which has no parent frame. Note that this ParentFrameInfo could be out of date as it's a snapshot.