FPCSubnet Object

Article
08/13/2010

The FPCSubnet object represents a subnet. A subnet specifies a range of IP addresses using a single IP address and a subnet mask that define a TCP/IP network segment. The subnet mask, whose binary value consists of a series of ones followed by a series of zeros, separates the IP address into two parts. The first part of the IP address becomes a network address, and the bits of the second part are reserved for all of the possible host addresses in the network segment.

The subnet mask typically consists of zero, one, two, or three binary octets that are represented in dotted-decimal format by the decimal number 255 and one binary octet that contains a series of ones (which may be empty) followed by a series of zeros and is represented by one of the following decimal numbers:

The subnets that are included in or excluded from a set of IP addresses are specified by including references to the applicable FPCNetworkSet objects in the FPCRefs collection held in the Subnets property of the FPCSelectionIPs object.

This object is an element of an FPCSubnets collection, and a new object representing a network set can be created by calling the Add method of this collection.

Dd421290.bkbutton(en-us,MSDN.10).png 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 FPCSubnet object does not define any methods.

Properties

The FPCSubnet object defines the following properties.

Property	Description
Description	Gets or sets the description of the subnet.
IPAddress	Gets or sets the IP address of the subnet.
IPMask	Gets or sets the IP mask of the subnet.
Name	Gets or sets the name of the subnet.

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 IFPCSubnet interface.

Requirements

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.

Share via