MtsPipeline.SetLogFile
.gif "Ee784818.c++_on(en-US,CS.10).gif")
.gif "Ee784818.vb_off(en-US,CS.10).gif")
Use this method to identify the file in which to log the operations of the pipeline component.
.gif "Ee784818.note(en-US,CS.10).gif")
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
Sub SetLogFile(pszFileName As String)
Parameters
pszFileName
A String containing the name of the file in which to log events.
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
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 object read and write operations.
Calling the method with an empty string turns off logging.
The SetLogFile method should be called immediately before executing a pipeline. The SetLogFile method is exposed on the OrderGroup object as the LogFile property and should be set before calling the RunPipe method.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
Example
' pMtsPipeline is a Commerce.MtsPipeline object
errVal = pMtsPipeline.SetLogFile("CustomShipping.log")
' pOrderGroup is an OrderGroup object
pOrderGroup.LogFile = "CustomShipping.log"