[C++]

The LoadDocProperties method retrieves the XML document's Comment and OptionalData properties so that you can know what information can be imported from the document.

HRESULT LoadDocProperties(
  IUnknown* pDocument,
  BSTR* ItemType,
  long* OptionalData,
  BSTR* Comment
);

Parameters

pDocument

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

ItemType

[out, optional] Pointer to a BSTR that on return contains a description of the type of item that is stored in the XML document.

OptionalData

[out, optional] 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

[out, optional] Pointer to a BSTR that on return contains the comment from the XML document. The comment was specifed in the call to the Export method that created the XML document.

Return Values

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

Remarks

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

[Visual Basic]

The LoadDocProperties method retrieves the XML document's Comment and OptionalData properties so that you can know what information can be imported from the document.

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

Parameters

pDocument

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

ItemType

[out, optional] String value that describes what type of item is stored in the XML document.

OptionalData

[out, optional] 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] 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 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

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