CoreWebView2Environment.GetClusterEnvironmentOptions(String) Method

Definition

Namespace:: Microsoft.Web.WebView2.Core

Assembly:: Microsoft.Web.WebView2.Core.dll

Package:: Microsoft.Web.WebView2 v1.0.4255-prerelease

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Synchronously reads the options of the cluster currently running for clusterName without spawning a browser.

public static Microsoft.Web.WebView2.Core.CoreWebView2ClusterEnvironmentOptions GetClusterEnvironmentOptions(string clusterName);

static member GetClusterEnvironmentOptions : string -> Microsoft.Web.WebView2.Core.CoreWebView2ClusterEnvironmentOptions

Public Shared Function GetClusterEnvironmentOptions (clusterName As String) As CoreWebView2ClusterEnvironmentOptions

Parameters

clusterName: String

The rendezvous name that identifies the cluster.

Returns

CoreWebView2ClusterEnvironmentOptions

Remarks

Returns null when no cluster is running for clusterName, and also in hosts that cannot use cluster environments. The value is a hint: it can be stale the instant it is read if the cluster's browser exits or another host establishes a different set concurrently. CreateOrJoinClusterEnvironmentAsync(CoreWebView2ClusterEnvironmentOptions) remains authoritative. Throws a COMException for a failing HRESULT, including E_INVALIDARG when clusterName is not a valid cluster name.

Applies to