Back to Adaptive Vision Library website

You are here: Start » Function Reference » Serial Port » SerialPort_WriteString



Writes string characters to serial port.


void avl::SerialPort_WriteString
	SerialPortState& ioState,
	int inPortId,
	const atl::String& inString,
	bool inASCIIMode,
	const atl::Array<int>& inTerminator


Name Type Range Default Description
ioState SerialPortState& Object used to maintain state of the function.
inPortId int 0 - 7 0 Identifies open port instance when working with multiple serial ports
inString const String&
inASCIIMode bool
inTerminator const Array<int>&


Filter writes inString characters to output buffer. By default string is send using UTF8 encoding (multi-byte).

When inASCIIMode is enabled filter will send only ASCII characters. Any attempt of sending non-ASCII character will result in domain error.


Using the SerialPort_Config filter is necessary before using the SerialPort_WriteString filter.


Using filters writing to serial port without previous configuration will cause "SerialPort not initialized" error.

List of possible exceptions:

Error type Description
DomainError SerialPort_WriteString can send only ASCII characters when inASCIIMode is selected.
When option inASCIIMode is enabled, filter can send only an ASCII characters. Please check ASCII table codes for more informations.

See Also