FPCArrays Collection

The FPCArrays collection holds a set of FPCArray objects. Each Forefront TMG computer is associated with an FPCArray object that represents a Forefront TMG array and provides access to the array-level configuration settings of the Forefront TMG computers that are associated with the array.

For multiple examples of using the FPCArrays collection, see Forefront TMG Administration Scripting.

The FPCArrays collection is accessed through the Arrays property of the FPC root object, and additional arrays are created using the Add method of this collection.

In Forefront TMG Medium Business Edition, the FPCArrays collection contains only one FPCArray object, which provides access to the configuration settings of a single Forefront TMG computer. In this case, the FPCArrays collection cannot be accessed through the Arrays property of the FPC root object, but the array object of the single Forefront TMG server can be retrieved by calling the GetContainingArray method of the root object.

Click here to see the Forefront TMG object hierarchy.

Methods

The FPCArrays collection defines the following methods.

Method Description

Add

Creates a new FPCArray object in the collection and returns a reference to it (not available in Forefront TMG Medium Business Edition).

CanImport

Returns a Boolean value that indicates whether the collection's properties can be imported from the specified XML document.

Connect

Connects to the specified ISA Server computer, adds the FPCArray object for the specified server to the collection, and returns a reference to the array object (deprecated in Forefront TMG).

Disconnect

Disconnects from the specified array (deprecated in Forefront TMG).

Export

Recursively writes all the properties of the collection and its elements, including all the properties of any subobjects and their elements (for collections), to the specified XML document.

ExportToFile

Recursively writes all the properties of the collection and its elements, including all the properties of any subobjects and their elements (for collections), to the specified XML file.

Import

Recursively copies the values of all the properties of the collection and its elements, including all the properties of any subobjects and their elements (for collections), from the specified XML document to persistent storage.

ImportFromFile

Recursively copies the values of all the properties of the collection and its elements, including all the properties of any subobjects and their elements (for collections), from the specified XML file to persistent storage.

Item

Retrieves the requested FPCArray object from the collection.

Refresh

Recursively reads the values of all the properties of the collection and its elements, including all the properties of its subobjects and their elements (for collections), from persistent storage, discarding any changes that have not been saved.

Remove

Removes the specified FPCArray object from the collection (not available in Forefront TMG Medium Business Edition).

Save

Recursively writes the current values of all the properties of the collection and its elements, including all the properties of its subobjects and their elements (for collections), to persistent storage.

Properties

The FPCArrays collection defines the following properties.

Property Description

_NewEnum

Gets an enumerator object for the collection.

Count

Gets the number of FPCArray objects in the collection.

Interfaces for C++ Programming

This object implements the IFPCArrays, IFPCEEArrays, and IFPCArrays2 interfaces.

Requirements

Client Requires Windows Vista or Windows XP.
Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).
IDL

Declared in Msfpccom.idl.

See Also

COM Objects


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.

[an error occurred while processing this directive]