FPCProtocolMessageDefinition collection
Applies to: desktop apps only
The FPCProtocolMessageDefinition collection holds a set of FPCProtocolMessageDefinitionParameter objects that represent the parameters in the definition of a type of protocol messages.
The FPCProtocolMessageDefinition collection is an element of an FPCProtocolMessageDefinitions collection, and a new object representing a protocol message definition can be created by calling the Add method of the FPCProtocolMessageDefinitions collection.
.png "Ff825863.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 FPCProtocolMessageDefinition collection has these types of members:
- Methods
- Properties
Methods
The FPCProtocolMessageDefinition collection has these methods.
| Method | Description |
|---|---|
| Add | Creates a new FPCProtocolMessageDefinitionParameter object in the collection and returns a reference to it. |
| Item | Retrieves the requested FPCProtocolMessageDefinitionParameter object from the collection. |
| Remove | Removes the specified FPCProtocolMessageDefinitionParameter object from the collection. |
Properties
The FPCProtocolMessageDefinition collection has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Gets an enumerator object for the collection. |
|
| Read-only | Gets the number of FPCProtocolMessageDefinitionParameter objects in the collection. |
|
| Read/write | Gets or sets the name of the protocol message definition. |
|
| Read/write | Gets or sets a value from the FpcProtocolMessageDefinitionTransportProtocol enumerated type that specifies the protocol used as a transport. |
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 and its elements can be imported from the specified XML document. |
| Export | Writes the stored values of all the properties of the collection and its elements to the specified XML document. |
| ExportToFile | Writes the stored values of all the properties of the collection and its elements 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 and its elements from the specified XML document to persistent storage. |
| ImportFromFile | Copies the values of all the properties of the collection and its elements 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 and its elements from persistent storage, overwriting any changes that have not been saved. |
| Save | Writes the current values of all the properties of the collection and its elements 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 object implements the IFPCProtocolMessageDefinition 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