IFPCPersist::LoadDocProperties method

Article
08/27/2012

Applies to: desktop apps only

The LoadDocProperties method retrieves the OptionalData and Comment properties that are stored in a specified XML document. These properties indicate what information can be imported from the document.

Syntax

HRESULT LoadDocProperties(
  [in, ref]        IUnknown &pDocument,
  [in]             IUnknown *pDocument,
  [out, optional]  String ItemType,
  [out, optional]  BSTR *ItemType,
  [out, optional]  Long OptionalData,
  [out, optional]  long *OptionalData,
  [out, optional]  String Comment,
  [out, optional]  BSTR *Comment
);

FPCPersist.LoadDocProperties( _
  ByRef pDocument As IUnknown, _
  ByVal pDocument As IUnknown, _
  [ ByRef ItemType As String ], _
  [ ByRef ItemType As BSTR ], _
  [ ByRef OptionalData As Long ], _
  [ ByRef OptionalData As long ], _
  [ ByRef Comment As String ], _
  [ ByRef Comment As BSTR ] _
)

Parameters

pDocument [in]

C++	Pointer to the IUnknown interface on the DOMDocument object from which the document properties will be obtained.
VB	Reference to the DOMDocument30 object from which the document properties will be obtained.

ItemType [out, optional]

C++	Pointer to a BSTR that on return contains a description of the type of item that is stored in the XML document.
VB	String value that describes what type of item is stored in the XML document.

OptionalData [out, optional]

C++	Pointer to a 32-bit integer that is set on return to a long value specifying what optional data is included in the XML document. This value is a bitwise combination of values from the FpcExportImportOptionalData enumerated type.
VB	A 32-bit integer that specifies what optional data is included in the XML document. This value is a bitwise combination of values from the FpcExportImportOptionalData enumerated type.

Comment [out, optional]

C++	Pointer to a BSTR that on return contains the comment from the XML document. The comment was specified in the call to the Export method that created the XML document.
VB	String value that provides the comment from the XML document. The comment was specified in the call to the Export method that created the XML document.

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.

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