Share via


Remove Method (String)

Removes the OrderForm from the current order form collection, based upon the specified name.

Namespace:  Microsoft.CommerceServer.Runtime.Orders
Assembly:  Microsoft.CommerceServer.Runtime (in Microsoft.CommerceServer.Runtime.dll)

Syntax

'Declaration
Public Sub Remove ( _
    orderFormName As String _
)
'Usage
Dim instance As OrderFormCollection
Dim orderFormName As String

instance.Remove(orderFormName)
public void Remove(
    string orderFormName
)
public:
void Remove(
    String^ orderFormName
)
public function Remove(
    orderFormName : String
)

Parameters

  • orderFormName
    Type: System..::.String
    The name of the OrderForm to remove. Cannot be nullNothingnullptra null reference (Nothing in Visual Basic).

Exceptions

Exception Condition
ArgumentNullException

orderForm is nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

Removes a specified OrderForm from the collection. When a OrderForm is removed from the collection, all subsequent OrderForm objects move up one index in the collection and the collection count is decremented.

Calling Remove updates LastModified,

Permissions

See Also

Reference

OrderFormCollection Class

OrderFormCollection Members

Remove Overload

Microsoft.CommerceServer.Runtime.Orders Namespace