StopFcn (Data Acquisition Toolbox)

Specify the M-file callback function to execute just after the device object stops running

Description

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.

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

Access
Read/write

Data type
String

Read-only when running
No

Usage	AI, AO, Common
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

StartFcn Tag