_OrderGroup::GetOrderFormAsXML

Ee811621.c++_off(en-US,CS.10).gifEe811621.vb_on(en-US,CS.10).gif

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

Definition

HRESULT _OrderGroup::GetOrderFormAsXML(BSTRnXMLLocale,VARIANTstrOrderFormName,BSTR*pbstrRetVal);

Parameters

nXMLLocale

[in] A BSTR that specifies the locale used in the XML string conversion.

strOrderFormName

[in, optional] A VARIANT that specifies the OrderForm.

pbstrRetVal

[out, retval] A pointer to a BSTR used to return the XML string.

Return Values

This method returns an HRESULT indicating whether or not it completed successfully. See the Error Values section for more details.

Error Values

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.

Remarks

The pbstrRetVal parameter points to valid data only if the method completed successfully.

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

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

See Also

OrderGroup Object

_OrderGroup::AddXMLAsOrderForm


All rights reserved.