RunPipeline Method (PipelineInfo)

2009-11-12

Executes the stages of the specified pipeline.

Namespace: Microsoft.CommerceServer.Runtime.Orders
Assembly: Microsoft.CommerceServer.Runtime (in Microsoft.CommerceServer.Runtime.dll)

Syntax

'Declaration
Public Overridable Function RunPipeline ( _
    pipelineInfo As PipelineInfo _
) As PipelineExecutionResult

'Usage
Dim instance As OrderGroup
Dim pipelineInfo As PipelineInfo
Dim returnValue As PipelineExecutionResult

returnValue = instance.RunPipeline(pipelineInfo)

public virtual PipelineExecutionResult RunPipeline(
    PipelineInfo pipelineInfo
)

public:
virtual PipelineExecutionResult RunPipeline(
    PipelineInfo^ pipelineInfo
)

public function RunPipeline(
    pipelineInfo : PipelineInfo
) : PipelineExecutionResult

Parameters

pipelineInfo
Type: Microsoft.CommerceServer.Runtime.Orders..::.PipelineInfo
A PipelineInfo that contains information used during pipeline processing. Cannot be nullNothingnullptra null reference (Nothing in Visual Basic).

Return Value

Type: Microsoft.CommerceServer.Runtime.Orders..::.PipelineExecutionResult
A PipelineExecutionResult enumeration value.

Exceptions

Exception	Condition
PipelineExecutionException	An error occurred while executing the pipeline.
OrderFormMarshallingException	An error occurred during order form marshalling from an IDictionary.
ArgumentNullException	pipelineInfo is nullNothingnullptra null reference (Nothing in Visual Basic).
InvalidOperationException	The order group has been disposed, either directly or by conversion from an OrderTemplate to a Basket or a Basket to a PurchaseOrder.
OverflowException	An error occurred while marshalling decimal values from the order system to currency values (Variant of type VT_CY) that is in the pipeline. This can happen if the decimal number is too large to represent as a currency or would lose precision if converted to a currency.

Remarks

Use this method to execute the stages of a specified pipeline. The returned PipelineExecutionResult enumeration value shall be one of the following:

Success - Signifies that the pipeline was executed successfully.
Warning - signifies that the warnings were reported by one or more pipeline components.

Note

You can only call this method within the ASP.NET application context, when a CommerceApplicationModule object exists. If your application does not run in a Web environment, use the overloaded RunPipeline method.

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.

Share via