PooledPipeline.LoadPipe Method (PIA)

  • Article

Use this method to load a pipeline configuration file (.pcf) into a 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 (.pcf) name.

[C#]

  • pszFileName
    A string containing the pipeline configuration file (.pcf) 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 that is designated to be used for transactions (for use in MtsTxPipeline or PooledTxPipeline).

Example

[Visual Basic .NET]

' pPooledPipeline is a Commerce.PooledPipeline object

errVal = pPooledPipeline.LoadPipe("CustomShip.pcf")

[C#]

No example available.

Requirements

Namespace: Microsoft.CommerceServer.Interop

Platforms: Windows 2000, Windows Server 2003

Assembly: pipelinelib (in pipelinelib.dll)

See Also

PooledPipeline Class

PooledPipeline.Execute

PooledPipeline.SetLogFile

Copyright © 2005 Microsoft Corporation.
All rights reserved.