ProxyConfiguration Class

Reference

Definition

Namespace:: Windows.Networking.Connectivity

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.

Edit

Represents the proxy configuration for the current user.

Note

This class is not supported on Windows Phone.

public ref class ProxyConfiguration sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ProxyConfiguration final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ProxyConfiguration

Public NotInheritable Class ProxyConfiguration

Inheritance: Object Platform::Object IInspectable ProxyConfiguration

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)
App capabilities	internetClient privateNetworkClientServer

Remarks

A ProxyConfiguration object is returned by calling the GetProxyConfigurationAsync method on the NetworkInformation object. If the GetProxyConfigurationAsync method is successful, the IAsyncOperation(ProxyConfiguration) handler for the method is passed a ProxyConfiguration object.

The proxy configuration returned is for the uri parameter passed to the GetProxyConfigurationAsync method. The uri parameter contains a hostname or IP address for the target endpoint and a service name, port number, or protocol scheme.

In a UWP app, the StreamSocket class supports connecting to a remote endpoint when proxies are required to plumb the connection. This support for proxies is automatic and transparent to the app. For more detailed information, see the remarks on Support for proxies in the StreamSocket class reference.

Properties

CanConnectDirectly	Gets a value that indicates if this configuration can connect directly. Note This class property is not supported on Windows Phone.
ProxyUris	Gets a list of URIs for the proxies from the proxy configuration. Note This class property is not supported on Windows Phone.

Applies to