ImportFromFile Method of the IFPCEE Interface

The ImportFromFile method recursively copies the values of all the properties of the object, including all the properties of its subobjects and their elements (for collections), from the specified XML file to persistent storage. This method also writes any unsaved configuration changes that were made before the method was called to persistent storage.

[C++]

Syntax

HRESULT ImportFromFile(
  [in]			BSTR XmlFileName,
  [in]			long OptionalData,
  [in, optional]  BSTR EncryptionPassword,
  [in, optional]  VARIANT_BOOL CleanCollections,
  [in, optional]  VARIANT_BOOL fResetRequiredServices,
  [in, optional]  VARIANT_BOOL fReloadConfiguration
);

Parameters

XmlFileName
BSTR that specifies the name of the XML file from which the data will be imported.
OptionalData

A 32-bit integer value that specifies what optional data to include in the import. This value is a bitwise combination of values from the FpcExportImportOptionalData enumerated type. The bits set should not call for the inclusion of optional data in the import that were not included in the export.

EncryptionPassword
BSTR that specifies a password for importing encrypted information. This parameter is an empty BSTR by default. The password is required if the export was performed using an encryption password.
CleanCollections
Boolean value that indicates whether to remove existing objects that are not included in the XML file. The default value is VARIANT_FALSE.
fResetRequiredServices
Boolean value that indicates whether to restart the services that need to be restarted for the changes to take effect. The default value is VARIANT_FALSE.
fReloadConfiguration
This parameter is provided for compatibility with ISA Server. The default value is VARIANT_TRUE. In Forefront TMG, this parameter is ignored.

Return Value

This method returns S_OK if the call is successful; otherwise, it returns an error code.

[Visual Basic]

Syntax

Sub ImportFromFile( _
  ByVal XmlFileName As String, _
  ByVal OptionalData As Long, _
  [ ByVal EncryptionPassword As String ], _
  [ ByVal CleanCollections As Boolean ], _
  [ ByVal fResetRequiredServices As Boolean ], _
  [ ByVal fReloadConfiguration As Boolean ] _
)

Parameters

XmlFileName
String that specifies the name of the XML file from which the data will be imported.
OptionalData

A 32-bit integer value that specifies what optional data to include in the import. This value is a bitwise combination of values from the FpcExportImportOptionalData enumerated type. The bits set should not call for the inclusion of optional data in the import that were not included in the export.

EncryptionPassword
String that specifies a password for importing encrypted information. This parameter is an empty string by default. The password is required if the export was performed using an encryption password.
CleanCollections
Boolean value that indicates whether to remove existing objects that are not included in the XML file. The default value is False.
fResetRequiredServices
Boolean value that indicates whether to restart the services that need to be restarted for the changes to take effect. The default value is False.
fReloadConfiguration
This parameter is provided for compatibility with ISA Server. The default value is True. In Forefront TMG, this parameter is ignored.

Return Value

This method has no return values. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.

Remarks

Imported configuration changes are applied only after the new settings are written to persistent storage and reloaded to the services that use them. Most changes can be applied dynamically without restarting any services. However, some changes can take effect only after the Microsoft Firewall service is restarted. For more information, see Restarting Services After Configuration Changes.

Forefront TMG maintains a bitmask that specifies which services need to be started for the unsaved configuration changes to take effect. This bitmask can be retrieved by calling the GetServiceRestartMask method. Calling the ImportFromFile method clears all of the bits in this bitmask even if the fResetRequiredServices parameter is set to False (VARIANT_FALSE in C++).

Calls to this method return only after the information has been written to a Configuration Storage server. If the Firewall service needs to be restarted to apply changes, it will be restarted on each Forefront TMG computer only after the changes are retrieved from a Configuration Storage server and written to the locally stored configuration.

For more information, see About Persistence.

This method is not supported in Forefront TMG Medium Business Edition.

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.
DLL

Requires Msfpccom.dll.

See Also

FPC


Send comments about this topic to Microsoft

Build date: 11/30/2009

 

© 2008 Microsoft Corporation. All rights reserved.