FPCISP object

Applies to: desktop apps only

The FPCISP object represents a single link to an Internet service provider (ISP).

The FPCISP object is an element of an FPCISPs collection, and a new object representing a link to an ISP can be created by calling the Add method of this collection.

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 FPCISP object has these types of members:

• Properties

Properties

The FPCISP object has these properties.

Property	Access type	Description
Description	Read/write	Gets or sets the description of the link.
ExplicitRoute	Read-only	Gets an FPCIpRangeSet collection that contains the list of destination IP address ranges that are excluded from load balancing for the link.
GatewayIPAddress	Read/write	Gets or sets the gateway IP address of the link.
GatewaySubnetMask	Read/write	Gets or sets the gateway subnet mask of the link.
LinkConnectivityStatus	Read/write	Gets or sets a value from the FpcIspLinkStatus enumerated type that specifies the connectivity status of the link.
LinkPriority	Read/write	Gets or sets a value from the FpcIspLinkPriority enumerated type that specifies the priority of the link.
LoadBalancingFactor	Read/write	Gets or sets the load balancing factor of the link.
Name	Read/write	Gets or sets the name of the Internet service provider (ISP).
OnlineConnectivityStatus	Read-only	Gets a value from the FpcLinkStatus enumerated type that specifies the online connectivity status of the link.
TransferRate	Read-only	Gets the transfer rate, in bytes per second, of the link.
UpTime	Read-only	Gets the up-time, in milliseconds, of the link.

 

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 IFPCISP 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

COM Objects

 

 

Build date: 7/12/2010