WebView2HeadersCollection class

An enumerator that yields WebView2Header values one by one. Returned by WebView2RequestHeaders.GetHeaders, WebView2ResponseHeaders.GetHeaders, and by For Each over a WebView2RequestHeaders or WebView2ResponseHeaders instance.

The collection implements the COM enumerator operations Next, Skip, Reset and Clone, which For Each and other COM enumerator clients call. They are not members that BASIC code can call. A loop reads the headers once, front to back; Reset starts the enumeration again from the first header. Every call to GetHeaders and every For Each loop produces a new enumerator, so a new loop always starts at the first header.

Clone returns an enumerator at the position of the enumerator it copies.

Warning

In BETA 1005, Clone on an enumerator of a WebView2ResponseHeaders collection that has been Reset starts as many headers in as the enumerator had read before the Reset: after two Next calls and a Reset, the enumerator’s Next returns the first header and the clone’s Next the third. An enumerator of WebView2RequestHeaders is not affected. For Each never calls Clone, so only a COM client that does is affected.

A WebView2HeadersCollection is never created by application code. The package returns one of the four derived classes listed under Derived classes, typed as WebView2HeadersCollection.

Private Sub WebView21_NavigationStarting( _
        ByVal Uri As String, _
        ByVal IsUserInitiated As Boolean, _
        ByVal IsRedirected As Boolean, _
        ByVal RequestHeaders As WebView2RequestHeaders, _
        Cancel As Boolean)

    Dim h As WebView2Header
    For Each h In RequestHeaders
        Debug.Print h.Name & ": " & h.Value
    Next
End Sub

Derived classes

Four public classes inherit from WebView2HeadersCollection. Each is [COMCreatable(False)], and application code does not create them: the package creates them and returns them as WebView2HeadersCollection. Each overrides Reset and Clone to work on its own source of headers.

Class	Returned by	Yields
WebView2HeadersCollection_RequestGetHeaders	WebView2RequestHeaders.GetHeaders	the request headers whose name matches the name argument
WebView2HeadersCollection_RequestEnumerator	`For Each` over a WebView2RequestHeaders	every request header
WebView2HeadersCollection_ResponseGetHeaders	WebView2ResponseHeaders.GetHeaders	the response headers whose name matches the name argument
WebView2HeadersCollection_ResponseEnumerator	`For Each` over a WebView2ResponseHeaders	every response header

Methods

New

Constructs the collection from the runtime’s header iterator. The constructor is Protected: only the four derived classes call it, and application code cannot create a WebView2HeadersCollection.