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

SerialPort_WriteString

Header:	STD.h
Namespace:	fil
Module:	FoundationLite

Writes string characters to serial port.

Syntax

void fil::SerialPort_WriteString
(
	SerialPortState& ioState,
	int inPortId,
	const ftl::String& inString,
	bool inASCIIMode,
	const ftl::Array<int>& inTerminator
)

Parameters

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>&

Examples

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.

Remarks

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

Errors

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

List of possible exceptions: