description | title | author | ms.author | ms.date | ms.topic | keywords |
---|---|---|---|---|---|---|
Event args for the `ClientCertificateRequested` event. |
WebView2 Win32 C++ ICoreWebView2ExperimentalClientCertificateRequestedEventArgs |
MSEdgeTeam |
msedgedevrel |
07/26/2021 |
reference |
IWebView2, IWebView2WebView, webview2, webview, win32 apps, win32, edge, ICoreWebView2, ICoreWebView2Controller, browser control, edge html, ICoreWebView2ExperimentalClientCertificateRequestedEventArgs |
[!INCLUDE deprecation-note]
[!INCLUDE prerelease-note]
interface ICoreWebView2ExperimentalClientCertificateRequestedEventArgs
: public IUnknown
Event args for the ClientCertificateRequested
event.
Members | Descriptions |
---|---|
get_AllowedCertificateAuthorities | Returns the ICoreWebView2ExperimentalStringCollection. |
get_Cancel | You may set this flag to cancel the certificate selection. |
get_Handled | You may set this flag to TRUE to respond to the server with or without a certificate. |
get_Host | Host name of the server that requested client certificate authentication. |
get_IsProxy | Returns true if the server that issued this request is an http proxy. |
get_MutuallyTrustedCertificates | Returns the ICoreWebView2ExperimentalClientCertificateCollection when client certificate authentication is requested. |
get_Port | Port of the server that requested client certificate authentication. |
get_SelectedCertificate | Returns the selected certificate. |
GetDeferral | Returns an ICoreWebView2Deferral object. |
put_Cancel | Sets the Cancel property. |
put_Handled | Sets the Handled property. |
put_SelectedCertificate | Sets the certificate to respond to the server. |
Product | Introduced |
---|---|
WebView2 Win32 | N/A |
WebView2 Win32 Prerelease | 1.0.902 |
Returns the ICoreWebView2ExperimentalStringCollection.
public HRESULT get_AllowedCertificateAuthorities(ICoreWebView2ExperimentalStringCollection ** value)
The collection contains distinguished names of certificate authorities allowed by the server.
You may set this flag to cancel the certificate selection.
public HRESULT get_Cancel(BOOL * value)
If canceled, the request is aborted regardless of the Handled
property. By default the value is FALSE
.
You may set this flag to TRUE
to respond to the server with or without a certificate.
public HRESULT get_Handled(BOOL * value)
If this flag is TRUE
with a SelectedCertificate
it responds to the server with the selected certificate otherwise respond to the server without a certificate. By default the value of Handled
and Cancel
are FALSE
and display default client certificate selection dialog prompt to allow the user to choose a certificate. The SelectedCertificate
is ignored unless Handled
is set TRUE
.
Host name of the server that requested client certificate authentication.
public HRESULT get_Host(LPWSTR * value)
Normalization rules applied to the hostname are:
-
Convert to lowercase characters for ascii characters.
-
Punycode is used for representing non ascii characters.
-
Strip square brackets for IPV6 address.
Returns true if the server that issued this request is an http proxy.
public HRESULT get_IsProxy(BOOL * value)
Returns false if the server is the origin server.
Returns the ICoreWebView2ExperimentalClientCertificateCollection when client certificate authentication is requested.
public HRESULT get_MutuallyTrustedCertificates(ICoreWebView2ExperimentalClientCertificateCollection ** value)
The collection contains mutually trusted CA certificates.
Port of the server that requested client certificate authentication.
public HRESULT get_Port(int * value)
Returns the selected certificate.
public HRESULT get_SelectedCertificate(ICoreWebView2ExperimentalClientCertificate ** value)
Returns an ICoreWebView2Deferral object.
public HRESULT GetDeferral(ICoreWebView2Deferral ** deferral)
Use this operation to complete the event at a later time.
Sets the Cancel
property.
public HRESULT put_Cancel(BOOL value)
Sets the Handled
property.
public HRESULT put_Handled(BOOL value)
Sets the certificate to respond to the server.
public HRESULT put_SelectedCertificate(ICoreWebView2ExperimentalClientCertificate * value)