External Interfaces/API Reference

record

Record data and event information to a file

Syntax

• record(obj)
  record(obj,'switch')
  

Arguments

obj	A serial port object.
'switch'	Switch recording capabilities on or off.

Description

record(obj) toggles the recording state for obj.

record(obj,'switch') initiates or terminates recording for obj. switch can be on or off. If switch is on, recording is initiated. If switch is off, recording is terminated.

Remarks

Before you can record information to disk, obj must be connected to the device with the fopen function. A connected serial port object has a Status property value of open. An error is returned if you attempt to record information while obj is not connected to the device. Each serial port object must record information to a separate file. Recording is automatically terminated when obj is disconnected from the device with fclose.

The RecordName and RecordMode properties are read-only while obj is recording, and must be configured before using record.

For a detailed description of the record file format and the properties associated with recording data and event information to a file, refer to Debugging: Recording Information to Disk.

Example

This example creates the serial port object s, connects s to the device, configures s to record information to a file, writes and reads text data, and then disconnects s from the device.

• s = serial('COM1');
  fopen(s)
  s.RecordDetail = 'verbose';
  s.RecordName = 'MySerialFile.txt';
  record(s,'on')
  fprintf(s,'*IDN?')
  out = fscanf(s);
  record(s,'off')
  fclose(s)
  

See Also

Functions

fclose, fopen

Properties

RecordDetail, RecordMode, RecordName, RecordStatus, Status

readasync

save (serial)