MtsTxPipeline.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 Site Server 3.0 Commerce Edition sites. In Site Server 3.0 Commerce Edition and later, the mode is set by loading an appropriately configured pipeline with LoadPipe method. Use a value of one (1). A value of zero (0) prevents any stages from running.
  • pdispOrder
    A reference to a Dictionary object. The Order dictionary that will be used by the pipeline, usually an OrderForm object.
  • pdispContext
    A reference to a Dictionary object. 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. In Site Server 3.0 Commerce Edition and later, the mode is set by loading an appropriately configured pipeline with LoadPipe method. Use a value of one (1). A value of zero (0) prevents any stages from running.
  • pdispOrder
    An object typically containing an OrderForm object that will be used by the pipeline.
  • pdispContext
    A object containing a Dictionary object.
  • 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.

In addition, the method returns one of the following three 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. For more details, see the Exceptions section.

The int value returned is set to one of the following three 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

' pMtsTxPipeline is a Commerce.MtsTxPipeline object
' dOrder and dContext are Commerce.Dictionary objects

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

Requirements

Namespace: Microsoft.CommerceServer.Interop

Platforms: Windows 2000, Windows Server 2003

Assembly: pipelinelib (in pipelinelib.dll)

See Also

MtsTxPipeline Object

MtsTxPipeline.LoadPipe

MtsTxPipeline.SetLogFile

Copyright © 2005 Microsoft Corporation.
All rights reserved.