LoadDocProperties Method of the IFPCPersist Interface

[C++]

Syntax

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

Parameters

pDocument

Pointer to the IUnknown interface on the DOMDocument object from which the document properties will be obtained.

ItemType

Pointer to a BSTR that on return contains a description of the type of item that is stored in the XML document.

OptionalData

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.

Comment

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.

Return Value

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

[Visual Basic]

Syntax

Sub LoadDocProperties( _
  ByRef pDocument As IUnknown, _
  [ ByRef ItemType As String ], _
  [ ByRef OptionalData As Long ], _
  [ ByRef Comment As String ] _
)

Parameters

pDocument

Reference to the DOMDocument30 object from which the document properties will be obtained.

ItemType

String value that describes what type of item is stored in the XML document.

OptionalData

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

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

This method has no return values. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.