  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Twelve — Internet Functions (continued)
Overview
The SerialGetProperties function gets the properties of an already open serial port in the form of an easily readable string array.
Syntax/Parameters
Syntax
string [] = SerialGetProperties ( handle hSerial );
Parameters
hSerial
A handle to a Serial Port Object.
Return Value
Returns a string array of serial properties. ERROR_NONE or a formatted error code on failure. Use the GetLastError to retrieve a formatted error code.
Remarks
The SerialGetProperties returns a list of named array entries as follows:
| Key Name | Description and Values | ||
| Port | The port name in the form of COMx where x is a number. | ||
| Channel | An integer value of the port number. | ||
| BaudRate | An integer value of the baud rate. | ||
| Bits | An integer value of the bits. | ||
| StopBits | A string as ‘1’, ‘1.5’ or ‘2’ for the stop bits. | ||
| Parity | A string as ‘None’, ‘Even’, or ‘Odd’. | ||
| Handshaking | A string as ‘None’, ‘Hardware’, or ‘Software’. | ||
| Duplex | A string as ‘Half’ or ‘Full’. |
The key names are uniform across this function, SerialGetPortSettings and SerialSetProperties.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.