Share via


PooledPipeline.LoadPipe

Ee824779.c++_on(en-US,CS.10).gifEe824779.vb_off(en-US,CS.10).gif

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

Definition

Sub LoadPipe(pszFileName As String)

Parameters

pszFileName

A String containing the pipeline configuration file (.pcf) name.

Return Values

None.

Error Values

This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

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).

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

Example

' pPooledPipeline is a Commerce.PooledPipeline object

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

See Also

PooledPipeline Object

PooledPipeline.Execute

PooledPipeline.SetLogFile


All rights reserved.