FPCClientAutoScript Object

The FPCClientAutoScript object defines the contents of the default automatic configuration script that can be used by Web browsers running on client computers in a network.

You can set the properties of the FPCWebBrowserClientConfig object so that Web browsers running on Forefront TMG Client and Firewall Client computers will be configured to use the automatic configuration script stored at the default location on the Forefront TMG server. In particular, Web browsers running on Forefront TMG Client and Firewall Client computers use the default automatic configuration script if the BrowserConfigScriptEnabled property is set to True and the BrowserConfigScriptFlag property is set to fpcBrowserDefaultScript. This script is then downloaded and executed by a Web browser running on a Forefront TMG Client or Firewall Client computer every time that the Web browser sends a request for a URL.

Because the configuration script is automatically made available to the Web browsers running on Forefront TMG Client and Firewall Client computers, you can update the Web browser settings on all Forefront TMG Client and Firewall Client computers without having to reconfigure the Web browser on each client computer.

Alternatively, you can construct your own custom automatic configuration script and place it on a Web server. When a Web browser looks for the configuration script at the URL that you specify, the Web server receives the request and returns the custom automatic configuration script to the browser.

Web browsers running on client computers on which neither Forefront TMG Client or Firewall Client is installed can be configured manually to use the default automatic configuration script (at https://<forefront_tmg_computer>:<HTTP_port>/Array.dll?Get.Routing.Script).

In deployments with an array containing more than one Forefront TMG computer (available only in Forefront TMG Enterprise Edition), the automatic configuration script also implements the Cache Array Routing Protocol (CARP) algorithm for selecting the Web proxy that can serve a request for a specific URL. A Web browser runs this script for each URL requested, and the CARP algorithm generates a prioritized list of array members that the Web browser should contact to retrieve the object specified by the URL being requested. For more information about the CARP algorithm, see Cache Array Routing Protocol.

The FPCClientAutoScript object can be accessed through the AutoScript property of an FPCWebBrowserClientConfig object.

Click here to see the Forefront TMG object hierarchy.

Methods

The FPCClientAutoScript object defines the following methods.

Method	Description
Refresh	Recursively reads all the values of the properties of the object, including all the properties of its subobjects and their elements (for collections), from persistent storage, discarding any changes that were not saved.
Save	Recursively writes the current values of all the properties of the object, including all the properties of its subobjects and their elements (for collections), to persistent storage.

Properties

The FPCClientAutoScript object defines the following properties.

Property	Description
BackupRoute	Gets an FPCClientBackupRoute object that represents the backup route settings in the default automatic configuration script for Web browsers running on client computers.
BypassLocalServers	Gets or sets a Boolean value that indicates whether Web browsers configured to use the default automatic configuration script will bypass the Web proxy for requests sent to non-dotted names.
ConvertUrlToLowerCase	Gets or sets a Boolean value that indicates whether URLs will be converted to lower case before checking for a match.
DirectAddressDestinations	Gets an FPCPublicNames collection containing the domain names of destinations that Web browsers configured to use the default automatic configuration script will access directly, bypassing the Web proxy.
DirectIPDestinations	Gets an FPCIpRangeSet collection containing the ranges of IP addresses that Web browsers configured to use the default automatic configuration script will access directly, bypassing the Web proxy.
IncludeLDT	Gets or sets a Boolean value that indicates whether the local domain table (LDT) is to be included in the list of directly accessed servers.
IncludeNetworkIpRangeSet	Gets or sets a Boolean value that indicates whether the IP address ranges of the network are to be included in the list of directly accessed servers.

Interfaces for C++ Programming

This object implements the IFPCClientAutoScript, IFPCClientAutoScript2, and IFPCClientAutoScript3 interfaces.

Requirements

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.

See Also

COM Objects

Send comments about this topic to Microsoft

Build date: 6/30/2010