FPCBranchCacheConfiguration Object

Article
08/13/2010

The FPCBranchCacheConfiguration object holds the BranchCache configuration settings for a Forefront TMG array. (This object is introduced in Forefront TMG 2010 SP 1.)

BranchCache in Hosted Cache mode can be enabled on Forefront TMG servers running on the Windows Server 2008 R2 operating system. When BranchCache in Hosted Cache mode is enabled, content arriving in a branch office from the main office can be cached locally on a Forefront TMG server in the branch office for local retrieval by clients in the same branch office.

When BranchCache in Hosted Cache mode is enabled, a Forefront TMG server can be configured as a Hosted Cache server in a branch office through the properties of the FPCHostedCacheServer object.

This object is accessed through the BranchCacheConfiguration property of the FPCArray object.

Ff796282.bkbutton(en-us,MSDN.10).png Click here to see the Forefront TMG object hierarchy.

Inheritance

This object inherits from the FPCPersist object, which contains methods and properties related to the persistent storage of an object's data. They include methods for exporting the object's data to and importing it from an XML document.

Methods

The FPCBranchCacheConfiguration object does not define any methods.

Properties

The FPCBranchCacheConfiguration object defines the following properties.

Property	Description
AppliedSSLCertificates	Gets an FPCAppliedSSLCertificates collection that contains objects defining the Secure Sockets Layer (SSL) server certificates used to authenticate the Forefront TMG server when a client connects to the BranchCache service through the SSL port.
BranchCacheEnabled	Gets or sets a Boolean value that indicates whether BranchCache in Hosted Cache mode is enabled.
DomainClientAuthenticationRequired	Gets or sets a Boolean value that indicates whether only client computers that are members of the same domain as the Forefront TMG server can be authenticated.

Methods Inherited from FPCPersist

Name	Description
CancelWaitForChanges	Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only).
CanImport	Returns a Boolean value that indicates whether the object's properties can be imported from the specified XML document.
Export	Writes the stored values of all of the object's properties to the specified XML document.
ExportToFile	Writes the stored values of all of the object's properties to the specified XML file.
GetServiceRestartMask	Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect.
Import	Copies the values of all of the object's properties from the specified XML document to persistent storage.
ImportFromFile	Copies the values of all of the object's properties from the specified XML file to persistent storage.
LoadDocProperties	Provides the XML document's properties so that you can know what information can be imported from the document.
Refresh	Reads the values of all of the object's properties from persistent storage, overwriting any changes that have not been saved.
Save	Writes the current values of all of the object's properties to persistent storage.
WaitForChanges	Registers to wait for an event indicating that the contents of the object have changed (for use in C and C++ programming only).

Properties Inherited from FPCPersist

Name	Description
PersistentName	Gets the persistent name of the object. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy.
VendorParameterSets	Gets an FPCVendorParametersSets object that can hold sets of custom data for extending the object.

Interfaces for C++ Programming

This object implements the IFPCBranchCacheConfiguration interface.

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.