_DictionaryXMLTransforms::ReconstructDictionaryFromXML Method [C++]

Article
11/12/2009

Use this method to transform the specified XML instance (which must comply with the specified schema) into a Dictionary object. If the schema was originally generated from an OrderForm object, the structure of the regenerated Dictionary object will reflect the OrderForm object.

Definition

[C++]

HRESULT _DictionaryXMLTransforms::ReconstructDictionaryFromXML(BSTRszDictionaryXML,
  IXMLDOMDocument*xmlSchema,
  IDictionary**RetValue);

[Visual Basic]

Function ReconstructDictionaryFromXML(szDictionaryXML As String,
  xmlSchema As Object) As Object

Parameters

szDictionaryXML[C++]
[in] A BSTR that contains the XML instance.
szDictionaryXML[Visual Basic]
A String that contains the XML instance.
xmlSchema[C++]
[in] A reference to the IXMLDOMDocument interface of the XMLDOMDocument object that contains the XML schema used in the conversion.
xmlSchema[Visual Basic]
An object reference to a XMLDOMDocument object that contains the XML schema.
RetValue[C++]
[out, retval] The address of a pointer to receive an IDictionary interface of the reconstructed Dictionary object.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] If this method completes successfully, it returns an object reference to a Dictionary object that contains the converted data.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

[C++] The RetValue parameter contains valid data only if the method completes successfully.

This method performs the inverse operation of the GenerateXMLForDictionaryUsingSchema method.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.