MtsPipeline.SetLogFile Method (PIA)

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

Note

• This method is for use by developers who want to analyze pipeline configuration file information. Logging should never be used in a production environment: it degrades performance and may compromise the security of credit card numbers in non-set transactions.

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 each component returns. The pipeline also logs all Dictionary and SimpleList read and write operations.

Calling the method with an empty string turns off logging.

The SetLogFile method should be called immediately before running a pipeline. The SetLogFile method is exposed on the OrderGroup object as the LogFile property and should be set before calling the RunPipe method.

Example

[Visual Basic .NET]

' pMtsPipeline is a Commerce.MtsPipeline object

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

' pOrderGroup is an OrderGroup object

pOrderGroup.LogFile = "CustomShipping.log"

[C#]

No example available.

Requirements

Namespace: Microsoft.CommerceServer.Interop

Platforms: Windows 2000, Windows Server 2003

Assembly: pipelinelib (in pipelinelib.dll)

See Also

MtsPipeline Class

MtsPipeline.Execute

MtsPipeline.LoadPipe

PooledPipeline Class

Copyright © 2005 Microsoft Corporation.
All rights reserved.