GetSerialPort

Returns information that is configured in the Serial Port Settings dialog. A valid serial Port (1) must be specified.

GetSerialPort Inputs

Syntax: EV GetSerialPort(Port)

Input

Description

Port

Specifies which serial port's data will be returned.

GetSerialPort Outputs

Returns a status code, followed by the number of characters (in bytes) for the results, then the results in XML format. The status codes are:

Status Codes Description
1 The command was executed successfully.
0 Unrecognized command.
-2 The command could not be executed.
-6 User does not have Full Access to execute the command. For more information, see User Access Settings Dialog.

GetSerialPort Example

To retrieve the information configured in the Serial Port Settings dialog, issue the following command: EV GetSerialPort(1)

The In-Sight sensor responds with a status code (1), followed by the number of characters, in bytes (477). Finally, the information configured in the Serial Port Settings dialog is returned.

Note: If Mode is set to 1 (Unused), GetSerialPort returns -1 for the Mode output.