Quantcast

Documentation Center

  • Trial Software
  • Product Updates

StopFcn

Specify callback function to execute after device object runs

Description

    Note:   You cannot use the legacy interface on 64–bit MATLAB®. See Session-Based Interface to acquire and generate data.

A stop event is generated immediately after the device object and hardware device stop executing. This occurs when

  • A stop function is issued.

  • For analog input (AI) objects, the requested number of samples to acquire was reached or data was missed. For analog output (AO) objects, the requested number of samples to output was reached.

  • A run-time error occurred.

A stop event executes the callback function specified for StopFcn. Under most circumstances, the callback function is not guaranteed to complete execution until sometime after the device object and hardware device stop, and the Running property is set to Off.

Stop event information is stored in the Type and Data fields of the EventLog property. The Type field value is Stop. The Data field values are given below.

Data Field Value

Description

AbsTime

The absolute time (as a clock vector) the event occurred.

RelSample

The acquired (AI) or output (AO) sample number when the event occurred.

Characteristics

Usage

AI, AO, common to all channels

Access

Read/write

Data type

String

Read-only when running

No

Values

The default value is an empty string.

See Also

Functions

stop

Properties

EventLog, Running

Was this topic helpful?