Share via

Export Method of the IFPCPersist Interface

  • Article

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

C++

Syntax

HRESULT Export(
  [in]            IUnknown* pDocument,
  [in]            long OptionalData,
  [in, optional]  BSTR EncryptionPassword,
  [in, optional]  BSTR Comment
);

Parameters

  • pDocument
    Pointer to the IUnknown interface on the DOMDocument object to which the information will be saved.

  • OptionalData
    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
    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.

  • Comment
    BSTR that specifies a comment for the exported information. This parameter contains an empty string by default.

Return Value

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

Visual Basic

Syntax

Sub Export( _
  ByRef pDocument As IUnknown, _
  ByVal OptionalData As Long, _
  [ ByVal EncryptionPassword As String ], _
  [ ByVal Comment As String ] _
)

Parameters

  • pDocument
    Reference to the DOMDocument30 object to which the information will be saved.

  • OptionalData
    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
    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
    String that specifies a comment for the exported information. This parameter is an empty string by default.

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

Any version of the XML DOM document object from Microsoft XML 4.0, XML 3.0, and XML 2.0 can be used.

For more information, see About Persistence.

Requirements

Client Requires Windows 7 or Windows Vista.
Server Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version Requires Forefront Threat Management Gateway (TMG) 2010.
IDL

Declared in Msfpccom.idl.
DLL

Requires Msfpccom.dll.

See Also

FPCPersist

Send comments about this topic to Microsoft

Build date: 6/30/2010