OrderGroup.GetOrderFormValue Method (PIA)

  • Article

Use this method to get an attribute from an OrderForm object, based on a specified key.

Definition

[Visual Basic .NET]

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

[C#]

using Microsoft.CommerceServer.Interop.Orders;
…
public object GetOrderFormValue(stringstrKey,
  objectstrOrderFormName);

Parameters

[Visual Basic .NET]

  • strKey
    A String that contains the key that specifies the attribute to get.
  • strOrderFormName
    An Object that specifies the OrderForm object name.

[C#]

  • strKey
    A string that contains the key that specifies the attribute to get.
  • strOrderFormName
    An object that specifies the OrderForm object name.

Return Values

[Visual Basic .NET] If this method completes successfully, it returns an Object that contains the attribute.

[C#] This method returns an object containing the requested attribute.

Exceptions

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

Remarks

If the strOrderFormName parameter is not supplied, the strOrderFormName parameter defaults to "default".

[Visual Basic .NET]

Example

' oOrderGroup is a Commerce.OrderGroup Object
vResult is an Object

vResult = oOrderGroup.GetOrderFormValue(handling_total, _
"testOrderFormName")

Requirements

Namespace: Microsoft.CommerceServer.Interop.Orders

Platforms: Windows 2000, Windows Server 2003

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

See Also

OrderGroup Class

Copyright © 2005 Microsoft Corporation.
All rights reserved.