OrderPipeline.LoadPipe Method (PIA)

  • Article

Use this method to load a pipeline configuration file (.pcf) into the pipeline.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop
…
Public Sub LoadPipe(pszFileName As String)

[C#]

using Microsoft.CommerceServer.Interop;
…
public void LoadPipe(stringpszFileName);

Parameters

[Visual Basic .NET]

  • pszFileName
    A String containing the pipeline configuration file name.

[C#]

  • pszFileName
    A string containing the pipeline configuration file name.

Exceptions

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

Remarks

The LoadPipe method must be called to initialize all pipelines.

The LoadPipe method fails if you attempt to load a pipeline configuration file designated for transactions (for use with the MtsTxPipeline or PooledTxPipeline objects).

[Visual Basic .NET]

Example

' pOrdPipeline is a Commerce.OrderPipeline object
errVal = pOrdPipeline.Load("CustomShip.pcf")

Requirements

Namespace: Microsoft.CommerceServer.Interop

Platforms: Windows 2000, Windows Server 2003

Assembly: pipelinelib (in pipelinelib.dll)

See Also

OrderPipeline Class

OrderPipeline.OrderExecute

OrderPipeline.SetLogFile

Copyright © 2005 Microsoft Corporation.
All rights reserved.