DictionaryXMLTransformsFreeThreaded.GenerateSampleXMLInstanceFromDictionary (OrderForm, String, Boolean) Method (PIA)

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

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop
…
Public Function GenerateSampleXMLInstanceFromDictionary(oForm As OrderForm,
  ElementName As String,
  bIgnoreUnderScore As Boolean) As Object

[C#]

using Microsoft.CommerceServer.Interop;
using MSXMLLib;                               //For IXMLDOMNode 
…
public IXMLDOMNode GenerateSampleXMLInstanceFromDictionary(OrderFormoForm,
  stringElementName,
  boolbIgnoreUnderScore);

Parameters

[Visual Basic .NET]

oForm
Interface to an OrderForm object that contains the data to convert into XML.
ElementName
A String that contains the element name.
bIgnoreUnderScore
A Boolean that that specifies whether to ignore dictionary keys with leading underscores in the dictionary. This value should generally be set to True.

[C#]

oForm
An OrderForm interface to a OrderForm object that contains the data to convert into XML.
ElementName
A string that contains the element name.
bIgnoreUnderScore
A bool that specifies whether to ignore dictionary keys with leading underscores in the dictionary. This value should generally be set to true.

Return Values

[Visual Basic .NET] If this method completes successfully, it returns an object reference used to return the XML instance.

[C#] This method returns an IXMLDOMNode interface of the newly created XMLDOMNode object containing the XML instance.

Exceptions

This method may throw one of many mapped exceptions or an exception of type CommerceException.

Requirements

Namespace: Microsoft.CommerceServer.Interop

Platforms: Windows 2000, Windows Server 2003

Assembly: Microsoft.CommerceServer.Runtime.DictionaryXMLTransform.dll