DeletePurchaseOrders Method (SearchClause, Int32)
For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.
Deletes the purchase orders from the database that satisfy the specified search criteria. 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 ( _
searchClause As SearchClause, _
<OutAttribute> ByRef recordsDeleted As Integer _
)
'Usage
Dim instance As PurchaseOrderManager
Dim searchClause As SearchClause
Dim recordsDeleted As Integer
instance.DeletePurchaseOrders(searchClause, _
recordsDeleted)
public void DeletePurchaseOrders(
SearchClause searchClause,
out int recordsDeleted
)
public:
void DeletePurchaseOrders(
SearchClause^ searchClause,
[OutAttribute] int% recordsDeleted
)
public function DeletePurchaseOrders(
searchClause : SearchClause,
recordsDeleted : int
)
Parameters
- searchClause
Type: Microsoft.CommerceServer..::.SearchClause
XML blob representing the search criteria
- recordsDeleted
Type: System..::.Int32%
Returns the number of records that match the search criteria.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | The searchClause is nullNothingnullptra null reference (Nothing in Visual Basic). |
| ArgumentNullException | The specified search clause is not a well formed search clause. |
| 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 satisfy the specified search criteria 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
- 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.