ErrorFcn

Specify callback function to execute when error event occurs

Description

You configure ErrorFcn to execute a callback function when an error event occurs.

    Note   An error event is generated only for asynchronous read and write operations.

An error event is generated when a timeout occurs. A timeout occurs if a read or write operation does not successfully complete within the time specified by the Timeout property. An error event is not generated for configuration errors such as setting an invalid property value.

If the RecordStatus property value is on, and an error event occurs, the record file records this information:

  • The event type as Error

  • The error message

  • The time the event occurred using the format day-month-year hour:minute:second:millisecond

To learn how to create a callback function, refer to Creating and Executing Callback Functions.

Characteristics

Usage

Any instrument object

Read only

Never

Data type

Callback function

Values

The default value is an empty string.

See Also

Functions

record

Properties

RecordStatus, Timeout

Was this topic helpful?