PooledTxPipeline.SetLogFile Method (PIA)

  • Article

Use this method to identify the file in which to log the operations of the pipeline component.

Ee796355.note(en-US,CS.20).gif Note

  • This method is for use by developers who want to analyze pipeline configuration file information. Logging should never be enabled in a production environment. It degrades performance and could compromise the security of credit card numbers in non-set transactions. File systems must be configured to allow the process running the pipeline to have write access to the specified path.

Definition

[Visual Basic .NET]

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

[C#]

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

Parameters

[Visual Basic .NET]

  • pszFileName
    A String containing the name of the file in which to log events.

[C#]

  • pszFileName
    A string containing the name of the file in which to log events.

Exceptions

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

Remarks

When logging is set, the pipeline logs the pipeline components that are called and the error values that each component returns. The pipeline also logs all Dictionary and SimpleList object read and write operations.

The SetLogFile method should be called immediately before executing a pipeline.

Calling this method with an empty string turns off logging.

[Visual Basic .NET]

Example

' pPooledTxPipeline is a Commerce.PooledTxPipeline object

errVal = pPooledTxPipeline.SetLogFile("CustomShipping.log")

Requirements

Namespace: Microsoft.CommerceServer.Interop

Platforms: Windows 2000, Windows Server 2003

Assembly: pipelinelib (in pipelinelib.dll)

See Also

PooledTxPipeline Class

PooledTxPipeline.Execute

PooledTxPipeline.LoadPipe

Copyright © 2005 Microsoft Corporation.
All rights reserved.