OrderPipeline.OrderExecute Method (PIA)

  • Article

Use this method to run the stages in the pipeline configuration file that was previously specified by the LoadPipe method.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop
…
Public Function OrderExecute(lMode As Integer,
  pdispOrder As Object,
  pdispContext As Object,
  lFlags As Integer) As Integer

[C#]

using Microsoft.CommerceServer.Interop;
…
int OrderExecute(intlMode,
  objectpdispOrder,
  objectpdispContext,
  intlFlags);

Parameters

[Visual Basic .NET]

  • lMode
    An Integer indicating the mode in which to run the pipeline. This parameter is provided only for backward compatibility with Site Server 2.0 sites.
  • pdispOrder
    A reference to a Dictionary object, usually an OrderForm object. This is the Order dictionary that will be used by the pipeline.
  • pdispContext
    A reference to a Dictionary object. This is the Context dictionary that will be used by the pipeline.
  • lFlags
    An unused Integer parameter. Must be set to zero (0).

[C#]

  • lMode
    An int indicating the mode in which to run the pipeline. This parameter is provided only for backward compatibility with Site Server 3.0 Commerce Edition sites. Commerce Server 2002 sites should set this parameter to one (1).
  • pdispOrder
    An object containing a Dictionary object (typically an OrderForm object). This is the Order dictionary that will be used by the pipeline.
  • pdispContext
    An object typically containing a Dictionary object. This is the Context dictionary that will be used by the pipeline.
  • lFlags
    An unused int parameter. Must be set to zero (0).

Return Values

[Visual Basic .NET] If this method completes successfully, it returns an Integer indicating whether there were warnings or errors detected by components in the pipeline. See the Exceptions section for more details.

[C#]

This method returns an int value indicating whether or not it completed successfully.

The int value returned is set to one of the following values:

Value Description
1 The pipeline ran successfully.
2 A pipeline component raised a warning. Generally, these are basket or user errors that would be reported to the user through the ASP page.
3 A pipeline component failed to run.

Exceptions

[Visual Basic .NET]

This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

In addition, the method returns one of the following values:

Value Description
1 The pipeline ran successfully.
2 A pipeline component raised a warning. Generally, these are basket or user errors that would be reported to the user through the ASP page.
3 A pipeline component failed to run.

[C#] This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

Remarks

The lMode parameter is included only for backward compatibility with sites created in Site Server 2.0. In Site Server 3.0 Commerce Edition and later, the selection of pipeline stages is made by loading an appropriate pipeline configuration file with the LoadPipe method. Commerce Server 2002 applications should use the value one (1) for this parameter; zero (0) will cause no stages to run.

[Visual Basic .NET]

Example

' pOrdPipeline is a Commerce.OrderPipeline object
' lMode is a Long
' dOrder and dContext are Commerce.Dictionary objects
errVal = pOrdPipeline.Execute(l, dOrder, dContext, 0)

Requirements

Namespace: Microsoft.CommerceServer.Interop

Platforms: Windows 2000, Windows Server 2003

Assembly: pipelinelib (in pipelinelib.dll)

See Also

OrderPipeline Class

OrderPipeline.LoadPipe

OrderPipeline.SetLogFile

Copyright © 2005 Microsoft Corporation.
All rights reserved.