FPCPersist object

Applies to: desktop apps only

The FPCPersist object provides access to the methods and properties associated with objects whose data can be written to persistent storage. Objects whose data can be written to persistent storage inherit from the FPCPersist object.

Click here to see the Forefront TMG object hierarchy.

Members

The FPCPersist object has these types of members:

• Methods
• Properties

Methods

The FPCPersist object has these methods.

Method	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. For a collection, the method also writes all of its elements and their properties to the XML document.
ExportToFile	Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML file. For a collection, the method also writes all of its elements and their properties to the 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. For a collection, the method also imports all of its elements and their properties from the XML document.
ImportFromFile	Recursively copies the values of all the properties of the object and of its subobjects from the specified XML file to persistent storage. For a collection, the method also imports all of its elements and their properties from the XML file.
LoadDocProperties	Retrieves the OptionalData and Comment properties that are stored in a specified XML 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. For a collection, the method also reads all of its elements and their properties from persistent storage.
Save	Recursively writes all of the properties of the object and its subobjects to persistent storage. For a collection, the method also writes all of its elements and their 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). After the notification, you must call the Refresh method to see the changes.

 

Properties

The FPCPersist object has these properties.

Property	Access type	Description
PersistentName	Read-only	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.
VendorParametersSets	Read-only	Gets an FPCVendorParametersSets collection that can hold custom data for extending the object.

 

Interfaces for C++ Programming

This object implements the IFPCPersist interface.

Remarks

To export to and import from an XML document in Visual Basic, you must add a project reference to Microsoft XML 3.0 in addition to the reference to the Microsoft Forefront Threat Management Gateway Administration Library.

In the event of an XML DOM parsing error, the information will be stored in an XMLDOMParseError object. For more information see XMLDOMParseError in the XML reference of MSDN.

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