FPCEnterprise object

Applies to: desktop apps only

The FPCEnterprise object defines the centrally managed enterprise and provides access to the configuration settings of the enterprise through its properties (available only in Forefront TMG Enterprise Edition).

Only enterprise-level configuration settings can be accessed through this object. In particular, array-level configuration settings cannot be accessed through it. For example, calling the ExportToFile method on this object exports only the enterprise configuration settings. To export the array-level configuration settings for all the arrays in your enterprise, you must call the ExportToFile method on the FPC root object or on the FPCArrays collection.

This object can be accessed through the Enterprise property of the FPC root object.

Ff824803.bkbutton(en-us,VS.85).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.

Members

The FPCEnterprise object has these types of members:

  • Properties

Properties

The FPCEnterprise object has these properties.

Property Access type Description

AdminSecurity

Read-only

Gets an FPCAdminSecurity object that holds the administration security settings for the enterprise.

ChangeTracking

Read-only

Gets an FPCChangeTracking object that provides access to the change tracking settings and log for the enterprise.

ConfigurationStorageServerVersion

Read/write

Gets or sets or sets a value from the FpcCompatibilityVersion enumerated type that specifies the version of Forefront TMG currently installed on the Configuration Storage servers in the enterprise. (This property is deprecated in Forefront TMG 2010 SP 1.)

ConfigurationStorageServerVersion2

Read/write

Gets or sets or sets a value from the FpcCompatibilityVersion enumerated type that specifies the version of Forefront TMG currently installed on the Configuration Storage servers in the enterprise. (This property is introduced in Forefront TMG 2010 SP 1.)

CreatedTime

Read-only

Gets a Date value that specifies the date and time in Coordinated Universal Time (UTC) when the enterprise was created.

CrossArrayLinkTranslationEnabled

Read/write

Gets or sets a Boolean value that indicates whether cross-array link translation is enabled in the enterprise.

Description

Read/write

Gets or sets the description of the enterprise.

Extensions

Read-only

Gets an FPCExtensions object that represents the set of application filters and Web filters for the enterprise.

LastModifiedTime

Read-only

Gets a Date value that specifies the date and time in Coordinated Universal Time (UTC) when the enterprise was last modified.

MinArrayVersion

Read/write

Gets or sets a value from the FpcCompatibilityVersion enumerated type that specifies the lowest compatibility version of an array in the enterprise.

Name

Read/write

Gets or sets the name of the enterprise.

NetworkConfiguration

Read-only

Gets an FPCNetworkConfiguration object that holds all the network configuration settings for the enterprise.

OverridingUrlCategories

Read-only

Gets an FPCUrlToCategoryMappings collection that contains the enterprise-level mappings of URLs to overriding URL categories. (This property is introduced in Forefront TMG 2010 SP 1.)

Policies

Read-only

Gets an FPCPolicies collection that holds the policies defined in the enterprise.

RuleElements

Read-only

Gets an FPCRuleElements object that provides access to collections of rule elements for the enterprise.

 

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 Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML document.
ExportToFile Recursively writes the stored values of all the properties of the object and its subobjects 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 Recursively copies the values of all the properties of the object and of its subobjects from the specified XML document to persistent storage.
ImportFromFile Recursively copies the values of all the properties of the object and of its subobjects 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 Recursively reads the values of all the properties of the object and of its subobjects from persistent storage, overwriting any changes that have not been saved.
Save Recursively writes the current values of all the properties of the object and its subobjects 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 collection that can hold sets of custom data for extending the object.

 

Interfaces for C++ Programming

This object implements the IFPCEEEnterprise, IFPCEnterprise2, IFPCEnterprise3, and IFPCEnterprise4 interfaces.

Requirements

Minimum supported client

Windows Vista, None supported

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)

Version

Forefront Threat Management Gateway (TMG) 2010

IDL

Msfpccom.idl

See also

COM Objects

 

 

Build date: 7/12/2010