IFPCArrays2::Export method

Article
08/27/2012

Applies to: desktop apps only

The Export method recursively writes all the properties of the collection and its elements, including all the properties of any subobjects and their elements (for collections), to the specified XML document.

Syntax

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

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

Parameters

pDocument [in]

C++
Pointer to the IUnknown interface on the DOMDocument object to which the information will be saved.

VB
Reference to the DOMDocument30 object to which the information will be saved.
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

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

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