Export (0) Print
Expand All

FPC

Internet Security and Acceleration Server 2004/2006 SDK

The FPC object is the root of the administration COM object hierarchy, and provides programmatic access to almost all of the other FPC objects. For a diagram of the entire hierarchy, see ISA Server Administration Object Model.

Creating this root object is the first step in making any programmatic changes to ISA Server. Using Visual Basic, you can create it with the following code:

  Dim root As New FPCLib.FPC

The CreateObject function is also available to Visual Basic programmers, and alternatively, the following can be used:

  Dim root As FPCLib.FPC
  Set root = CreateObject("FPC.Root")

Scripts written in Visual Basic Scripting Edition (VBScript) must use the CreateObject function to create the root object, as in the following code example:

  Dim root  ' This line may be omitted.
  Set root = CreateObject("FPC.Root")

For information about creating the root object in other programming languages, see Creating the Root ISA Server Object.

After the FPC object is created, objects below it in the hierarchy can be accessed through the methods and properties of the root object.

  • All the array-level configuration settings defined in the hierarchy of administration COM objects for the ISA Server computers associated with an array can be accessed through the applicable FPCArray object, which is an element of the FPCArrays collection. The way in which an FPCArray object is retrieved depends on the edition of ISA Server that is installed on the computer on which the root object was created and on the components of ISA Server that are installed and running on it. For information about retrieving an FPCArray object after creating the root object, see Retrieving an Array Object.
  • The Arrays property of the root object provides access to the FPCArrays collection, of all the FPCArray objects within the root node. In ISA Server Standard Edition, this collection contains only one FPCArray object, which provides access to configuration settings of a single ISA Server computer.
  • In ISA Server Enterprise Edition, the Enterprise property of the root object retrieves the FPCEnterprise object that represents the enterprise to which the current ISA Server computer is connected. The FPCEnterprise object provides access to all of the configuration settings of the enterprise through its properties.

After creating an instance of the FPC object and making changes to the properties of any object accessed through it, your code should not impersonate a different user. For example, changes made to the ISA Server configuration in one security context cannot be written to persistent storage in a different security context.

For examples of the use of the FPC root object, see ISA Server Administration Scripting.

Click here to see the ISA Server object hierarchy.

Methods

The FPC object defines the following methods.

Method Description
CanImport Returns a Boolean value that indicates whether the object's properties can be imported from the specified XML document (available only in Enterprise Edition).
ConnectToConfigServerPort Connects to the enterprise using the specified Configuration Storage server on a specific port. (This method is introduced in ISA Server 2006 Enterprise Edition.)
ConnectToConfigurationStorageServer Connects to the enterprise using the specified Configuration Storage server (available only in Enterprise Edition).
DisconnectFromConfigurationStorageServer Closes the connection to the Configuration Storage server used for connecting to the enterprise (available only in Enterprise Edition).
Export Recursively writes all of the properties of the object, including all the properties of its subobjects and their elements (for collections), to the specified XML document (available only in Enterprise Edition).
ExportToFile Recursively writes all of the properties of the object, including all the properties of its subobjects and their elements (for collections), to the specified XML file (available only in Enterprise Edition).
GetContainingArray Retrieves the FPCArray object that represents the array containing the current computer.
GetContainingServer Retrieves the FPCServer object that represents the current ISA Server computer.
Import Recursively copies the values of all the properties of the object, including all the properties of its subobjects and their elements (for collections), from the specified XML document to persistent storage (available only in Enterprise Edition).
ImportFromFile Recursively copies the values of all the properties of the object, including all the properties of its subobjects and their elements (for collections), from the specified XML file to persistent storage (available only in Enterprise Edition).
LoadDocProperties Retrieves the OptionalData and Comment properties that are stored in a specified XML document (available only in Enterprise Edition).
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 (available only in Enterprise Edition).
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 (available only in Enterprise Edition).

Properties

The FPC object has the following properties.

Property Description
Arrays Gets an FPCArrays collection that contains all the ISA Server arrays for the root object.
ConfigurationStorageServer Gets the name of the Configuration Storage server used for connecting to the enterprise (available only in Enterprise Edition).
Enterprise Gets an FPCEnterprise object that represents the ISA Server enterprise within the root object (available only in Enterprise Edition).
IsaEdition Gets a value from the FpcIsaEditionType enumerated type that indicates whether ISA Server Standard Edition or ISA Server Enterprise Edition is installed. (This property is introduced in ISA Server 2006.)
VendorMode Gets or sets a Boolean value that indicates whether the system policy configuration is in vendor mode. (This property is introduced in ISA Server 2006.)

Interfaces for C++ Programming

This object implements the IFPC interface. In Enterprise Edition, this object implements the IFPCEE interface.

Requirements

Client Requires Windows XP.
Server Requires Windows Server 2003. Requires Windows Server 2003 or Windows 2000 for ISA Server 2004 Standard Edition.
Version Requires Internet Security and Acceleration (ISA) Server 2006 or ISA Server 2004.
IDL

Declared in Msfpccom.idl.

See Also

COM Objects

Show:
© 2014 Microsoft