DeletePurchaseOrders Method (Guid[], Int32)

Deletes a group of purchase orders from the database that match the supplied identifiers. 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 DeletePurchaseOrders ( _
    orderGroupIDs As Guid(), _
    <OutAttribute> ByRef recordsDeleted As Integer _
)
'Usage
Dim instance As PurchaseOrderManager
Dim orderGroupIDs As Guid()
Dim recordsDeleted As Integer

instance.DeletePurchaseOrders(orderGroupIDs, _
    recordsDeleted)
public void DeletePurchaseOrders(
    Guid[] orderGroupIDs,
    out int recordsDeleted
)
public:
void DeletePurchaseOrders(
    array<Guid>^ orderGroupIDs, 
    [OutAttribute] int% recordsDeleted
)
public function DeletePurchaseOrders(
    orderGroupIDs : Guid[], 
    recordsDeleted : int
)

Parameters

  • orderGroupIDs
    Type: array<System..::.Guid>[]()[]
    An array of order group identifiers.
  • recordsDeleted
    Type: System..::.Int32%
    Returns the number of records that match the search criteria.

Exceptions

Exception Condition
NotAuthorizedException

User does not have permission to perform this operation.

TimeoutException

Thrown if an SQL command timeout occurs.

Remarks

Deletes purchase orders from the database that match the supplied identifiers and supplies a count of the number of purchase orders deleted.

In order to perform a DeletePurchaseOrders, the user must have the OrdersConfigurationEditor 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

See Also

Reference

PurchaseOrderManager Class

PurchaseOrderManager Members

DeletePurchaseOrders Overload

Microsoft.CommerceServer.Orders Namespace