DeleteBaskets Method (Guid[], Int32)
Deletes all baskets that match an order group identifier. The number of deleted records is available.
Namespace: Microsoft.CommerceServer.Orders
Assembly: Microsoft.CommerceServer.Orders.CrossTierTypes (in Microsoft.CommerceServer.Orders.CrossTierTypes.dll)
Syntax
'Declaration
Public Sub DeleteBaskets ( _
orderGroupIDs As Guid(), _
<OutAttribute> ByRef recordsDeleted As Integer _
)
'Usage
Dim instance As BasketManager
Dim orderGroupIDs As Guid()
Dim recordsDeleted As Integer
instance.DeleteBaskets(orderGroupIDs, _
recordsDeleted)
public void DeleteBaskets(
Guid[] orderGroupIDs,
out int recordsDeleted
)
public:
void DeleteBaskets(
array<Guid>^ orderGroupIDs,
[OutAttribute] int% recordsDeleted
)
public function DeleteBaskets(
orderGroupIDs : Guid[],
recordsDeleted : int
)
Parameters
- orderGroupIDs
Type: array<System..::.Guid>[]()[]
The collection of order group identifiers to search for.
- recordsDeleted
Type: System..::.Int32%
Returns the number of records that match orderGroupIDs.
Exceptions
| Exception | Condition |
|---|---|
| TimeoutException | Thrown if an SQL command timeout occurs. |
Remarks
Deletes all baskets that match an order group identifier and supplies a count of the number of baskets deleted.
In order to perform a DeleteBaskets, the user must have the OrdersAdministrator permissions. See Orders System Roles [CS06] for more information about the specific roles in the Order System.
Some order system APIs support distributed transactions. If a cookie with a valid transaction is found the order system enlists as part of that transaction. If a valid transaction is not found the order system initiates a new transaction.
Permissions
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.