Execute Method

Implements the Execute method of IPipelineComponent interface.

Namespace:  Microsoft.CommerceServer.Inventory
Assembly:  Microsoft.CatalogServer (in Microsoft.CatalogServer.dll)

Syntax

'Declaration
Public Function Execute ( _
    pdispOrder As Object, _
    pdispContext As Object, _
    lFlags As Integer _
) As Integer
'Usage
Dim instance As CheckInventory
Dim pdispOrder As Object
Dim pdispContext As Object
Dim lFlags As Integer
Dim returnValue As Integer

returnValue = instance.Execute(pdispOrder, _
    pdispContext, lFlags)
public int Execute(
    Object pdispOrder,
    Object pdispContext,
    int lFlags
)
public:
virtual int Execute(
    Object^ pdispOrder, 
    Object^ pdispContext, 
    int lFlags
) sealed
public final function Execute(
    pdispOrder : Object, 
    pdispContext : Object, 
    lFlags : int
) : int

Parameters

  • pdispOrder
    Type: System..::.Object
    An order dictionary object containing the complete order related details.
  • pdispContext
    Type: System..::.Object
    A Context dictionary object containing the context information.

Return Value

Type: System..::.Int32
A value indicating success status of pipeline component execution.

Exceptions

Exception Condition
ArgumentNullException

pdispOrderis nullNothingnullptra null reference (Nothing in Visual Basic)

ArgumentNullException

pdispContext is nullNothingnullptra null reference (Nothing in Visual Basic)

Remarks

Use this method to execute a pipeline component.

Execute instantiates inventory context class, iterates through all the line items in the order and performs inventory check for each line item.

The return value indicates the success status.

Value

Description

Meaning

1

Success

success status of pipeline component execution

2

Warning

warning status of pipeline component execution

3

Failure

error status of pipeline component execution

Permissions

See Also

Reference

CheckInventory Class

CheckInventory Members

Microsoft.CommerceServer.Inventory Namespace