Library.StartLog Method

This method requests a log.

Namespace:  IntervalZero.MaxRT.Libraries.VariableDatabase
Assembly:  IntervalZero.MaxRT.Libraries (in IntervalZero.MaxRT.Libraries.dll) Version: 1.0.0.0 (File version: 1.0.1)

Syntax

Copy
public Log StartLog(
    Channel[] channels,
    Trigger trigger,
    double duration,
    uint loggerChannel
)

Parameters

channels

Type: Channel[]
The array of channels to log.

trigger

Type: Trigger
The trigger to start the log.

duration

Type: Double
The duration, in seconds, of the log.

loggerChannel

Type: UInt32
The channel used to synchronize logging.

Return Value

Type: Log
The class that controls the log request.

InvalidOperationException is thrown when the library is not open.

ArgumentNullException is thrown when parameter channels is null.

ArgumentOutOfRangeException is thrown when parameter channels is empty or parameter loggerChannel is not in the channels range.

MaxRTNativeException is thrown when these errors occur:

Error code Meaning

ERROR_INVALID_PARAMETER

One of the following conditions occurred:

  • The channel count is greater than limit.
  • Log buffer variable with incorrect channel offset.
  • Incorrect channel index in parameter trigger.

ERROR_ALREADY_EXISTS

A log request is in progress.

ERROR_ABANDONED_WAIT_0

Failed to acquire the synchronization lock.

See Also: