IFPCPersist::ExportToFile method

Article
08/27/2012

Applies to: desktop apps only

The ExportToFile method recursively writes the all of 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.

Syntax

HRESULT ExportToFile(
  [in]            BSTR XmlFileName,
  [in]            long OptionalData,
  [in, optional]  BSTR EncryptionPassword,
  [in, optional]  BSTR Comment
);

FPCPersist.ExportToFile( _
  ByVal XmlFileName As String, _
  ByVal OptionalData As Long, _
  [ ByVal EncryptionPassword As String ], _
  [ ByVal Comment As String ] _
)

Parameters

XmlFileName [in]

C++ BSTR that specifies the name of the XML file to which the data will be exported.

VB String that specifies the name of the XML file to which the data will be exported.
OptionalData [in]
A 32-bit integer value that specifies what optional data to include in the export. This value is a bitwise combination of values from the FpcExportImportOptionalData enumerated type.

EncryptionPassword [in, optional]

C++	BSTR that specifies a password for encrypting the exported information. The default value is an empty BSTR. This parameter must be specified if the fpcExportImportPasswords bit is set in the OptionalData parameter.
VB	String that specifies a password for encrypting the exported information. The default value is an empty string. This parameter must be specified if the fpcExportImportPasswords bit is set in the OptionalData parameter.

Comment [in, optional]

C++	BSTR that specifies a comment for the exported information. This parameter contains an empty string by default.
VB	String that specifies a comment for the exported information. This parameter is an empty string by default.

Return value

C++

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

VB

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

For more information, see About Persistence.

Examples

For a VBScript code example that shows how to use this method to export the configuration of a Forefront TMG computer to a specified .xml file, see Exporting and Importing a Forefront TMG Configuration.

Requirements

Minimum supported client	Windows Vista
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
DLL	Msfpccom.dll