OrderGroup.GetOrderFormAsXML Method (PIA)

  • Article

Use this method to convert an OrderForm object into an XML string.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Orders
…
Public Function GetOrderFormAsXML(nXMLLocale As String,
  Optional strOrderFormName As Object) As String

[C#]

using Microsoft.CommerceServer.Interop.Orders;
…
public string GetOrderFormAsXML(stringnXMLLocale,
  objectstrOrderFormName);

Parameters

[Visual Basic .NET]

  • nXMLLocale
    A String that specifies the locale used in the XML string conversion.
  • strOrderFormName
    An Object that specifies the OrderForm object.

[C#]

  • nXMLLocale
    A string that specifies the locale used in the XML string conversion.
  • strOrderFormName
    An object that specifies the OrderForm object.

Return Values

[Visual Basic .NET] If this method completes successfully, it returns a String that contains the XML string.

[C#] This method returns a string indicating whether or not it completed successfully.

Exceptions

This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

Remarks

Ee799207.note(en-US,CS.20).gif Note

  • Use of the DictionaryXMLTransforms object is recommended when exchanging XML through BizTalk Server. The DictionaryXMLTransforms object allows you to write out XML to a well-defined schema.

[Visual Basic .NET]

Example

' oOrderGroup is a Commerce.OrderGroup object
' lLocale is a valid Locale identifier
sXMLResultString is a String
sXMLResultString = oOrderGroup.GetOrderFormAsXML(lLocale, myOrderFormName)

Requirements

Namespace: Microsoft.CommerceServer.Interop.Orders

Platforms: Windows 2000, Windows Server 2003

Assembly: Microsoft.CommerceServer.Interop.Orders.Requisition.dll

See Also

OrderGroup Class

OrderGroup.AddXMLAsOrderForm

Copyright © 2005 Microsoft Corporation.
All rights reserved.