Network.setProxyBypassForLocal method

[The feature associated with this page, Windows Media Player SDK, is a legacy feature. It has been superseded by MediaPlayer. MediaPlayer has been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer instead of Windows Media Player SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The setProxyBypassForLocal method specifies a value indicating whether the proxy server is bypassed if the origin server is on a local network.

Syntax

Network.setProxyBypassForLocal(
  protocol,
  bypass
)

Parameters

protocol [in]

String specifying the protocol name. For a list of supported protocols, see Supported Protocols and File Types.

bypass [in]

Boolean specifying whether the proxy server is bypassed.

Return value

This method does not return a value.

Remarks

This method has no effect unless getProxySettings returns a value of 2 (use manual settings).

This method fails unless the calling application is running on the local computer or intranet.

Windows Media Player 10 Mobile: This method is not supported.

Examples

The following JScript example uses Network.setProxyBypassForLocal to specify whether the Windows Media Player proxy server is bypassed, when using the MMS protocol, if the origin server is on a local network. The Player object was created with ID = "Player".

// Test whether the proxy settings are manual.
if (Player.network.getProxySettings("MMS") == 2){

   // Prompt the user for a setting. Store the response in a variable.
   var proxybypass = confirm("Bypass proxy server for local addresses? \n OK = Yes \n Cancel = No");

   // Set the proxy bypass value using the user input.
   Player.network.setProxyBypassForLocal("MMS", proxybypass);
}

else

// Warn that proxy settings must be set to 2.
alert("Proxy settings must be manual!");

Requirements

See also

Network Object