FPCIpListProvider Object

The FPCIpListProvider object represents a single IP list provider.

The FPCIpListProvider object is an element of an FPCIpListProviders collection, and a new object representing an IP list provider 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.

Methods

The FPCIpListProvider object does not define any methods.

Properties

The FPCIpListProvider object defines the following properties.

Property	Description
BlockedProviderErrorMessage	Gets or sets a error message for blocked IP address.
BlockedProviderErrorMessageType	Gets or sets a FpcBlockedProviderErrorMessageType value that indicates the type of error message for blocked IP address.
Description	Gets or sets the description of the provider.
DomainName	Gets or sets the domain name of the provider.
Enabled	Gets or sets a Boolean value that indicates whether the provider is enabled.
Mask	Gets or sets the match mask for the provider.
MatchAnyReturnCode	Gets or sets a Boolean value that indicates whether any result code will be matched.
MatchedResponses	Gets an FPCIPAddresses collection that contains the list of responses that will bi matched.
Name	Gets or sets the name of the provider.

Methods Inherited from FPCPersist

Name	Description
CancelWaitForChanges	Cancels the registration established by the WaitForChanges method - for C/C++ only (does not work with DCOM).
CanImport	Checks if object properties can be imported from a given xml document.
Export	Exports object properties to an xml document.
ExportToFile	Exports object properties to an xml file.
GetServiceRestartMask	Get a bitmask of the services that need to be restarted so that currently unsaved changes will take effect.
Import	Imports object properties from an xml document.
ImportFromFile	Imports object properties from an xml file.
LoadDocProperties	Retrieves the XML document's OptionalData and Comment properties.
Refresh	Reads all the items from persistent storage.
Save	Saves all configuration changes to persistent storage.
WaitForChanges	Registers to wait for an event indicating that the contents of the FPCVendorParametersSet object have changed - for C/C++ only (does not work with DCOM).

Properties Inherited from FPCPersist

Name	Description
PersistentName	Retrieves the persistent name of the object.
VendorParametersSets	Gets a reference to an object that stores vendor-specific data.

Interfaces for C++ Programming

This object implements the IFPCIpListProvider interface.

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.