Microsoft Internet Security and Acceleration Server 2004 SDK

IFPCPersist::ExportToFile[C++]

FPCPersist.ExportToFile [Visual Basic]

[C++]

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.

HRESULT ExportToFile(
  BSTR XmlFileName,
  long OptionalData,
  BSTR EncryptionPassword,
  BSTR Comment
);

Parameters

XmlFileName
[in] BSTR 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] BSTR that specifies a password for encrypting the exported information. This parameter is an empty string by default.
Comment
[in, optional] BSTR that specifies a comment for the exported information. This parameter contains an empty string by default.

Return Values

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

Remarks

For more information, see About Persistence.

[Visual Basic]

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.

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

Parameters

XmlFileName
[in] 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] String that specifies a password for encrypting the exported information. This parameter is an empty string by default.
Comment
[in, optional] String that specifies a comment for the exported information. This parameter is an empty string by default.

Return Values

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.

Requirements

Server: Requires Windows Server 2003 or Windows 2000.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Msfpccom.idl.
Library: Use Microsoft Internet Security and Acceleration Server 2004 Administration Library.

See Also

FPCPersist