Share via

PipelineBase Constructor (String, String, Boolean, String, Boolean)

  • Article

Initializes a new instance of the PipelineBase class with the specified parameter values.

Namespace:  Microsoft.CommerceServer.Runtime.Pipelines
Assembly:  Microsoft.CommerceServer.Runtime (in Microsoft.CommerceServer.Runtime.dll)

Syntax

'Declaration
Protected Sub New ( _
    name As String, _
    pipelineConfigPath As String, _
    loggingEnabled As Boolean, _
    logPath As String, _
    transactional As Boolean _
)

'Usage
Dim name As String
Dim pipelineConfigPath As String
Dim loggingEnabled As Boolean
Dim logPath As String
Dim transactional As Boolean

Dim instance As New PipelineBase(name, pipelineConfigPath, _
    loggingEnabled, logPath, transactional)

protected PipelineBase(
    string name,
    string pipelineConfigPath,
    bool loggingEnabled,
    string logPath,
    bool transactional
)

protected:
PipelineBase(
    String^ name, 
    String^ pipelineConfigPath, 
    bool loggingEnabled, 
    String^ logPath, 
    bool transactional
)

protected function PipelineBase(
    name : String, 
    pipelineConfigPath : String, 
    loggingEnabled : boolean, 
    logPath : String, 
    transactional : boolean
)

Parameters

  • name
    Type: System..::.String
    Friendly name of the pipeline, used as a unique reference. Cannot be nullNothingnullptra null reference (Nothing in Visual Basic).
  • pipelineConfigPath
    Type: System..::.String
    Fully qualified path to the pipeline configuration file. Cannot be nullNothingnullptra null reference (Nothing in Visual Basic).
  • loggingEnabled
    Type: System..::.Boolean
    true if pipeline logging should be enabled for this pipeline; otherwise, false.
  • logPath
    Type: System..::.String
    The location (directory) of the pipeline log file. Cannot be nullNothingnullptra null reference (Nothing in Visual Basic) if logging is enabled. The full pipeline log path is of the form "logPath\user_id.pipelog".
  • transactional
    Type: System..::.Boolean
    true if the pipeline should be executed in the transactional mode; otherwise, false for TransactionalNotSupported.

Exceptions

Exception Condition
ArgumentNullException

One of the name, pipelineConfigPath, or logPath (if loggingEnabled is true) parameters is nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

Called by derived classes to construct the abstract PipelineBase class with the specified parameter values. Implements the functionality for the derived classes. The abstract class PipelineBase is the base class for pipeline objects. The following classes derive from the PipelineBase class:

Permissions

See Also

Reference

PipelineBase Class

PipelineBase Members

PipelineBase Overload

Microsoft.CommerceServer.Runtime.Pipelines Namespace