SerialPort.SetXON
-----------------

Sets the serial port to use XON/XOFF mode.

| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|---|
| [SerialPort](component_SerialPort.md) | [3.4](newinversion34.md) | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes, on macOS and Windows | ❌ No |

MBS( "SerialPort.SetXON"; PortReference; Value ) 

**MBS**( **"SerialPort.SetXON";** /\* Sets the serial port to use XON/XOFF mode. \*/  
**$PortReference**; /\* The reference number of the port. You get this number from [SerialPort.Open](SerialPortOpen.md) when you open the port.e.g. $port \*/   
**$Value**) /\* 0 to turn off, 1 to turn on.e.g. 1 \*/ 

### Parameters

| Parameter | Description | Example |
|---|---|---|
| PortReference | The reference number of the port. You get this number from [SerialPort.Open](SerialPortOpen.md) when you open the port. | $port |
| Value | 0 to turn off, 1 to turn on. | 1 |

### Result

Returns OK or error message.

### Description

Sets the serial port to use XON/XOFF mode.  
If set to 1, we use XON/XOFF flow control is used during reception and transmission.  
### Examples

Turn XON/XOFF mode on:

 MBS ( "SerialPort.SetXON"; $SerialPort ; 1 )  
Turn XON/XOFF mode off:

 MBS ( "SerialPort.SetXON"; $SerialPort ; 0 )  
### See also

- [SerialPort.GetRTS](SerialPortGetRTS.md)
- [SerialPort.GetTag](SerialPortGetTag.md)
- [SerialPort.Open](SerialPortOpen.md)
- [SerialPort.Resume](SerialPortResume.md)
- [SerialPort.SetCTS](SerialPortSetCTS.md)
- [SerialPort.SetDSR](SerialPortSetDSR.md)
- [SerialPort.SetDTR](SerialPortSetDTR.md)
- [SerialPort.SetRTS](SerialPortSetRTS.md)
- [SerialPort.SetTag](SerialPortSetTag.md)
- [SerialPort.Setup](SerialPortSetup.md)

This function is free to use.

Created 18th August 2014 , last changed 24th February 2018

  
[SerialPort.SetTag](SerialPortSetTag.md) - [SerialPort.Setup](SerialPortSetup.md)

[HTML Version](SerialPortSetXON.shtml)