PooledTxPipeline.Execute Method (PIA)

  • Article

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

Definition

[Visual Basic .NET]

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

[C#]

using Microsoft.CommerceServer.Interop;
…
public int Execute(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 previous versions of Commerce Server. Specify 1 (one) for this parameter.
  • pdispOrder
    A reference to a business Object (typically a Dictionary object or an OrderForm object). The Order dictionary that will be used by the pipeline.
  • pdispContext
    A reference to a secondary business Object (typically a context dictionary object).
  • lFlags
    An unused Integer parameter. Must be set to zero (0).

[C#]

  • lMode
    A int integer indicating the mode in which to run the pipeline. This parameter is provided only for backward compatibility with previous versions of Commerce Server. Specify 1 (one) for this parameter.

  • pdispOrder
    An object containing a Dictionary object (typically an OrderForm object). The Order dictionary that will be used by the pipeline.

    pdispContext

    An object typically containing a Dictionary object. 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 value indicating whether components in the pipeline detected warnings or errors. See the Exceptions section for more 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 returns an int value indicating whether or not it completed successfully. See the Exceptions section for more details.

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

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

[Visual Basic .NET]

Example

' dOrder, dContext are Commerce.Dictionary objects
' pPooledTxPipeline is a Commerce.PooledTxPipeline object

errVal = pPooledTxPipeline.Execute(1, dOrder, dContext, 0)

Requirements

Namespace: Microsoft.CommerceServer.Interop

Platforms: Windows 2000, Windows Server 2003

Assembly: pipelinelib (in pipelinelib.dll)

See Also

PooledTxPipeline Class

PooledTxPipeline.LoadPipe

PooledTxPipeline.SetLogFile

Copyright © 2005 Microsoft Corporation.
All rights reserved.