_DictionaryXMLTransforms::GenerateXMLForDictionaryUsingSchema Method [C++]

Article
11/12/2009

Use this method to extract an XML instance from the specified Dictionary or OrderForm object that conforms to the specified schema.

Definition

[C++]

HRESULT _DictionaryXMLTransforms::GenerateXMLForDictionaryUsingSchema(IDictionary*Dictionary,
  IXMLDOMDocument*xmlSchema,
  IXMLDOMNode**RetValue);

[Visual Basic]

Function GenerateXMLForDictionaryUsingSchema(Dictionary As Object,
  xmlSchema As Object) As Object

Parameters

Dictionary[C++]
[in] A pointer to the IDictionary interface of the Dictionary object to be converted.
Dictionary[Visual Basic]
A Dictionary object that contains the data to be converted.
xmlSchema[C++]
[in] A reference to the IXMLDOMDocument interface of the XMLDOMDocument object that contains the XML schema.
xmlSchema[Visual Basic]
An XMLDOMDocument object that contains the XML schema.
RetValue[C++]
[out, retval] A pointer to hold the reference to the returned IXMLDOMNode interface of a XMLDOMNode object, which will contain the XML instance.

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 XMLDOMNode object that contains the XML schema.

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.

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

[Visual Basic]

Example

' oDictionaryXMLTransforms is a Commerce.DictionaryXMLTransforms object
' dDict is a Dictionary object
' oXMLDOMDocument is a XMLDOMDocument object
' oXMLDOMNode is a XMLDOMNode object
oXMLDOMNode = _
oDictionaryXMLTransforms.GenerateXMLForDictionaryUsingSchema(dDict, _
    oXMLDOMDocument)

Share via