_DictionaryXMLTransforms::GenerateSampleXMLInstanceFromDictionary Method [C++]

Article
11/12/2009

Use this method to generate an XML Data Reduced (XDR) schema. This method produces an XML instance based on the specified Dictionary or OrderForm object. You can then import this XML instance into a tool (such as the BizTalk Editor) that can construct a schema based on a given instance.

Definition

[C++]

HRESULT _DictionaryXMLTransforms::GenerateSampleXMLInstanceFromDictionary(IDictionary*Dictionary,
  BSTRElementName,
  VARIANT_BOOLbIgnoreUnderScore,
  IXMLDOMNode**RetValue);

[Visual Basic]

Function GenerateSampleXMLInstanceFromDictionary(Dictionary As Object,
  ElementName As String,
  bIgnoreUnderScore As Boolean) As Object

Parameters

Dictionary[C++]
[in] A pointer to the IDictionary interface of a Dictionary object that contains the data to convert into XML.
Dictionary[Visual Basic]
A Dictionary object that contains the data to convert into XML.
ElementName[C++]
[in] A BSTR that contains the element name.
ElementName[Visual Basic]
A String that contains the element name.
bIgnoreUnderScore[C++]
[in] A VARIANT_BOOL that specifies whether to ignore dictionary keys with leading underscores in the dictionary. This value should generally be set to True.
bIgnoreUnderScore[Visual Basic]
A Boolean that that specifies whether to ignore dictionary keys with leading underscores in the dictionary. This value should generally be set to True.
RetValue[C++]
[out, retval] The address of the pointer to the IXMLDOMNode interface of the newly created XMLDOMNode object containing 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 object reference used to return the XML instance.

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

This method cannot operate on OrderForms that have empty lists if the bIgnoreUnderScore parameter of this method is set to False.

[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.