FPCWebListener object

Applies to: desktop apps only

The FPCWebListener object represents a single Web listener. A Web listener is a rule element that can be used in a Web publishing rule. By default, every incoming Web request must go through the Web listener that is specified for the Web publishing rule that allows the request.

The FPCWebListener object representing the Web listener used in a specific Web publishing rule is referenced through the FPCRef object held in the WebListenerUsed property of the FPCWebPublishingProperties object for the rule.

The Web listeners that are included in or excluded from the sources for which HTTP compression is enabled are specified by including references to the applicable FPCWebListener objects in the FPCRefs collection held in the WebListeners property of the FPCHTTPCompressionConfiguration object.

This object is an element of an FPCWebListeners collection, and a new object representing a Web listener 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 FPCWebListener object has these types of members:

• Properties

Properties

The FPCWebListener object has these properties.

Property	Access type	Description
Description	Read/write	Gets or sets the description of the Web listener.
IPsOnNetworks	Read-only	Gets an FPCIPsOnNetworks collection that contains information about the IP addresses on which the Web listener listens for Web requests from particular networks.
Name	Read/write	Gets or sets the name of the Web listener.
Properties	Read-only	Gets an FPCWebListenerProperties object that contains the properties of the Web listener.
SourceNetworkSets	Read-only	Gets an FPCRefs collection that contains references to the network sets to which the Web listener listens.

 

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	Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML document.
ExportToFile	Recursively writes the stored values of all the properties of the object and its 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	Recursively copies the values of all the properties of the object and of its subobjects from the specified XML document to persistent storage.
ImportFromFile	Recursively copies the values of all the properties of the object and of its 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	Recursively reads the values of all the properties of the object and of its subobjects from persistent storage, overwriting any changes that have not been saved.
Save	Recursively writes the current values of all the properties of the object and its subobjects 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 collection that can hold sets of custom data for extending the object.

 

Interfaces for C++ Programming

This collection implements the IFPCWebListener 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