FPCServerFarms collection
Applies to: desktop apps only
The FPCServerFarms collection holds a set of FPCServerFarm objects that represent all of the server farms defined in a Forefront TMG array.
The FPCServerFarms collection is accessed through the ServerFarms property of an FPCRuleElements object.
.png "Ff826300.bkbutton(en-us,VS.85).png")
Click here to see the Forefront TMG object hierarchy.
Inheritance
This collection 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 an object's data to and importing it from XML documents.
Members
The FPCServerFarms collection has these types of members:
- Methods
- Properties
Methods
The FPCServerFarms collection has these methods.
| Method | Description |
|---|---|
| Add | Creates a new FPCServerFarm object in the collection and returns a reference to it. |
| Item | Retrieves the requested FPCServerFarm object from the collection. |
| Remove | Removes the specified FPCServerFarm object from the collection. |
Properties
The FPCServerFarms collection has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Gets an enumerator object for the collection. |
|
| Read-only | Gets the number of FPCServerFarm objects in the collection. |
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 properties of the collection, its elements, and their subobjects can be imported from the specified XML document. |
| Export | Writes the stored values of all the properties of the collection, its elements, and their subobjects to the specified XML document. |
| ExportToFile | Writes the stored values of all the properties of the collection, its elements, and their 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 | Copies the values of all the properties of the collection, its elements, and their subobjects from the specified XML document to persistent storage. |
| ImportFromFile | Copies the values of all the properties of the collection, its elements, and their 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 | Reads the values of all the properties of the collection, its elements, and their subobjects from persistent storage, overwriting any changes that have not been saved. |
| Save | Writes the current values of all the properties of the collection, its elements, and their subobjects to persistent storage. |
| WaitForChanges | Registers to wait for an event indicating that the contents of the collection have changed (for use in C and C++ programming only). |
Properties Inherited from FPCPersist
| Name | Description |
|---|---|
| PersistentName | Gets the persistent name of the collection. 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 collection. |
Interfaces for C++ Programming
This collection implements the IFPCServerFarms interface.
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
Build date: 7/12/2010