Print Class Reference

Base class that provides print() and println() functionality. More...

#include <Print.h>

Inheritance diagram for Print:

Public Member Functions
	Print ()
	Default constructor.
virtual int	availableForWrite ()
	Get the number of bytes available in the write buffer. More...
void	clearWriteError ()
	Clear the write error state.
virtual void	flush ()
	Flush the output buffer. More...
int	getWriteError ()
	Get the current write error state. More...
virtual bool	outputCanTimeout ()
	Check if the output can timeout. More...
size_t	print (char)
	Print a single character. More...
size_t size_t size_t	print (const __FlashStringHelper *)
	Print a flash string. More...
size_t	print (const char[])
	Print a null-terminated string. More...
size_t	print (const Printable &)
	Print a Printable object. More...
size_t	print (const String &)
	Print a String object. More...
size_t	print (double, int=2)
	Print a floating point value. More...
size_t	print (int, int=DEC)
	Print an integer value. More...
size_t	print (long long, int=DEC)
	Print a long long integer value. More...
size_t	print (long, int=DEC)
	Print a long integer value. More...
size_t	print (unsigned char, int=DEC)
	Print an unsigned byte value. More...
size_t	print (unsigned int, int=DEC)
	Print an unsigned integer value. More...
size_t	print (unsigned long long, int=DEC)
	Print an unsigned long long integer value. More...
size_t	print (unsigned long, int=DEC)
	Print an unsigned long integer value. More...
size_t	printf (const char *format,...) __attribute__((format(printf
	Print formatted data (printf style) More...
size_t size_t	printf_P (PGM_P format,...) __attribute__((format(printf
	Print formatted data from program memory (printf style) More...
size_t	println (char)
	Print a single character followed by a newline. More...
size_t	println (const __FlashStringHelper *)
	Print a flash string followed by a newline. More...
size_t	println (const char[])
	Print a null-terminated string followed by a newline. More...
size_t	println (const Printable &)
	Print a Printable object followed by a newline. More...
size_t	println (const String &s)
	Print a String object followed by a newline. More...
size_t	println (double, int=2)
	Print a floating point value followed by a newline. More...
size_t	println (int, int=DEC)
	Print an integer value followed by a newline. More...
size_t	println (long long, int=DEC)
	Print a long long integer value followed by a newline. More...
size_t	println (long, int=DEC)
	Print a long integer value followed by a newline. More...
size_t	println (unsigned char, int=DEC)
	Print an unsigned byte value followed by a newline. More...
size_t	println (unsigned int, int=DEC)
	Print an unsigned integer value followed by a newline. More...
size_t	println (unsigned long long, int=DEC)
	Print an unsigned long long integer value followed by a newline. More...
size_t	println (unsigned long, int=DEC)
	Print an unsigned long integer value followed by a newline. More...
size_t	println (void)
	Print just a newline. More...
template<>
size_t	printNumber (double number, uint8_t digits)
	Specialized template for printing floating point numbers. More...
size_t	write (char c)
	Write a char value as a byte. More...
size_t	write (const char *buffer, size_t size)
	Write a buffer of characters to the output. More...
size_t	write (const char *str)
	Write a null-terminated string to the output. More...
virtual size_t	write (const uint8_t *buffer, size_t size)
	Write a buffer of bytes to the output. More...
size_t	write (int t)
	Write an int value as a byte. More...
size_t	write (int8_t c)
	Write a signed byte as an unsigned byte. More...
size_t	write (long long t)
	Write a long long value as a byte. More...
size_t	write (long t)
	Write a long value as a byte. More...
size_t	write (short t)
	Write a short value as a byte. More...
virtual size_t	write (uint8_t)=0
	Write a single byte to the output. More...
size_t	write (unsigned int t)
	Write an unsigned int value as a byte. More...
size_t	write (unsigned long long t)
	Write an unsigned long long value as a byte. More...
size_t	write (unsigned long t)
	Write an unsigned long value as a byte. More...
size_t	write (unsigned short t)
	Write an unsigned short value as a byte. More...

Protected Member Functions
void	setWriteError (int err=1)
	Set the write error flag. More...

Detailed Description

Base class that provides print() and println() functionality.

The Print class is the base class for all Arduino objects that can write output, including Serial, Ethernet clients, and File objects. It provides a common interface for printing various data types to these output destinations.

Member Function Documentation

availableForWrite()

virtual int Print::availableForWrite ( )

inlinevirtual

Get the number of bytes available in the write buffer.

Returns

The number of bytes available in the write buffer (0 by default)

Note

Subclasses should override this if they implement buffering

Reimplemented in esp32_psram::RingBufferStream< VectorType >.

flush()

virtual void Print::flush ( )

inlinevirtual

Flush the output buffer.

This function should wait for all outgoing characters to be sent. The output buffer should be empty after this call. Empty implementation by default in Print class.

Reimplemented in esp32_psram::RingBufferStream< VectorType >, and esp32_psram::InMemoryFile< VectorType >.

getWriteError()

int Print::getWriteError ( )

inline

Get the current write error state.

Returns

Current error code (0 = no error)

outputCanTimeout()

virtual bool Print::outputCanTimeout ( )

inlinevirtual

Check if the output can timeout.

By default, write operations can timeout (like for network or serial). Child classes can override this to false (like String).

Returns

true if output operations can timeout, false otherwise

print() [1/13]

size_t Print::print

(

char

)

Print a single character.

Parameters

c	Character to print

Returns

Number of bytes written

print() [2/13]

size_t size_t size_t Print::print

(

const __FlashStringHelper *

)

Print a flash string.

Parameters

str	Flash string to print

Returns

Number of bytes written

print() [3/13]

size_t Print::print

(

const char

[]

)

Print a null-terminated string.

Parameters

str	String to print

Returns

Number of bytes written

print() [4/13]

size_t Print::print

(

const Printable &

)

Print a Printable object.

Parameters

obj	Object to print

Returns

Number of bytes written

print() [5/13]

size_t Print::print

(

const String &

)

Print a String object.

Parameters

s	String to print

Returns

Number of bytes written

print() [6/13]

size_t Print::print	(	double	,
		int	= 2
	)

Print a floating point value.

Parameters

n	Value to print
digits	Number of decimal places to display (default: 2)

Returns

Number of bytes written

print() [7/13]

size_t Print::print	(	int	,
		int	= DEC
	)

Print an integer value.

Parameters

n	Value to print
base	Number base to use (default: DEC)

Returns

Number of bytes written

print() [8/13]

size_t Print::print	(	long long	,
		int	= DEC
	)

Print a long long integer value.

Parameters

n	Value to print
base	Number base to use (default: DEC)

Returns

Number of bytes written

print() [9/13]

size_t Print::print	(	long	,
		int	= DEC
	)

Print a long integer value.

Parameters

n	Value to print
base	Number base to use (default: DEC)

Returns

Number of bytes written

print() [10/13]

size_t Print::print	(	unsigned char	,
		int	= DEC
	)

Print an unsigned byte value.

Parameters

b	Value to print
base	Number base to use (default: DEC)

Returns

Number of bytes written

print() [11/13]

size_t Print::print	(	unsigned int	,
		int	= DEC
	)

Print an unsigned integer value.

Parameters

n	Value to print
base	Number base to use (default: DEC)

Returns

Number of bytes written

print() [12/13]

size_t Print::print	(	unsigned long long	,
		int	= DEC
	)

Print an unsigned long long integer value.

Parameters

n	Value to print
base	Number base to use (default: DEC)

Returns

Number of bytes written

print() [13/13]

size_t Print::print	(	unsigned long	,
		int	= DEC
	)

Print an unsigned long integer value.

Parameters

n	Value to print
base	Number base to use (default: DEC)

Returns

Number of bytes written

printf()

size_t Print::printf	(	const char *	format,
			...
	)

Print formatted data (printf style)

Parameters

format	Format string
...	Variable arguments for format string

Returns

Number of bytes written

printf_P()

size_t size_t Print::printf_P	(	PGM_P	format,
			...
	)

Print formatted data from program memory (printf style)

Parameters

format	Format string in program memory
...	Variable arguments for format string

Returns

Number of bytes written

println() [1/14]

size_t Print::println

(

char

)

Print a single character followed by a newline.

Parameters

c	Character to print

Returns

Number of bytes written

println() [2/14]

size_t Print::println

(

const __FlashStringHelper *

)

Print a flash string followed by a newline.

Parameters

str	Flash string to print

Returns

Number of bytes written

println() [3/14]

size_t Print::println

(

const char

[]

)

Print a null-terminated string followed by a newline.

Parameters

str	String to print

Returns

Number of bytes written

println() [4/14]

size_t Print::println

(

const Printable &

)

Print a Printable object followed by a newline.

Parameters

obj	Object to print

Returns

Number of bytes written

println() [5/14]

size_t Print::println

(

const String &

s

)

Print a String object followed by a newline.

Parameters

s	String to print

Returns

Number of bytes written

println() [6/14]

size_t Print::println	(	double	,
		int	= 2
	)

Print a floating point value followed by a newline.

Parameters

n	Value to print
digits	Number of decimal places to display (default: 2)

Returns

Number of bytes written

println() [7/14]

size_t Print::println	(	int	,
		int	= DEC
	)

Print an integer value followed by a newline.

Parameters

n	Value to print
base	Number base to use (default: DEC)

Returns

Number of bytes written

println() [8/14]

size_t Print::println	(	long long	,
		int	= DEC
	)

Print a long long integer value followed by a newline.

Parameters

n	Value to print
base	Number base to use (default: DEC)

Returns

Number of bytes written

println() [9/14]

size_t Print::println	(	long	,
		int	= DEC
	)

Print a long integer value followed by a newline.

Parameters

n	Value to print
base	Number base to use (default: DEC)

Returns

Number of bytes written

println() [10/14]

size_t Print::println	(	unsigned char	,
		int	= DEC
	)

Print an unsigned byte value followed by a newline.

Parameters

b	Value to print
base	Number base to use (default: DEC)

Returns

Number of bytes written

println() [11/14]

size_t Print::println	(	unsigned int	,
		int	= DEC
	)

Print an unsigned integer value followed by a newline.

Parameters

n	Value to print
base	Number base to use (default: DEC)

Returns

Number of bytes written

println() [12/14]

size_t Print::println	(	unsigned long long	,
		int	= DEC
	)

Print an unsigned long long integer value followed by a newline.

Parameters

n	Value to print
base	Number base to use (default: DEC)

Returns

Number of bytes written

println() [13/14]

size_t Print::println	(	unsigned long	,
		int	= DEC
	)

Print an unsigned long integer value followed by a newline.

Parameters

n	Value to print
base	Number base to use (default: DEC)

Returns

Number of bytes written

println() [14/14]

size_t Print::println

(

void

)

Print just a newline.

Returns

Number of bytes written

printNumber()

template<>

size_t Print::printNumber	(	double	number,
		uint8_t	digits
	)

Specialized template for printing floating point numbers.

Parameters

number	The floating point number to print
digits	The number of decimal places to display

Returns

Number of bytes written

setWriteError()

void Print::setWriteError ( int  err = 1 )

inlineprotected

Set the write error flag.

Parameters

err	Error code to set (default: 1)

write() [1/14]

size_t Print::write ( char  c )

inline

Write a char value as a byte.

Parameters

c	Character to write

Returns

Number of bytes written

write() [2/14]

size_t Print::write ( const char *  buffer, size_t  size  )

inline

Write a buffer of characters to the output.

Parameters

buffer	Pointer to the character buffer
size	Number of characters to write

Returns

Number of bytes written

write() [3/14]

size_t Print::write ( const char *  str )

inline

Write a null-terminated string to the output.

Parameters

str	Pointer to the string to write

Returns

Number of bytes written

write() [4/14]

virtual size_t Print::write ( const uint8_t *  buffer, size_t  size  )

virtual

Write a buffer of bytes to the output.

Parameters

buffer	Pointer to the data to write
size	Number of bytes to write

Returns

Number of bytes written

Reimplemented in esp32_psram::RingBufferStream< VectorType >, and esp32_psram::InMemoryFile< VectorType >.

write() [5/14]

size_t Print::write ( int  t )

inline

Write an int value as a byte.

Parameters

t	Value to write

Returns

Number of bytes written

write() [6/14]

size_t Print::write ( int8_t  c )

inline

Write a signed byte as an unsigned byte.

Parameters

c	Byte to write

Returns

Number of bytes written

write() [7/14]

size_t Print::write ( long long  t )

inline

Write a long long value as a byte.

Parameters

t	Value to write

Returns

Number of bytes written

write() [8/14]

size_t Print::write ( long  t )

inline

Write a long value as a byte.

Parameters

t	Value to write

Returns

Number of bytes written

write() [9/14]

size_t Print::write ( short  t )

inline

Write a short value as a byte.

Parameters

t	Value to write

Returns

Number of bytes written

write() [10/14]

virtual size_t Print::write ( uint8_t  )

pure virtual

Write a single byte to the output.

Parameters

b	The byte to write

Returns

Number of bytes written (1 on success, 0 on failure)

Note

This is a pure virtual function that must be implemented by subclasses

Implemented in esp32_psram::RingBufferStream< VectorType >, and esp32_psram::InMemoryFile< VectorType >.

write() [11/14]

size_t Print::write ( unsigned int  t )

inline

Write an unsigned int value as a byte.

Parameters

t	Value to write

Returns

Number of bytes written

write() [12/14]

size_t Print::write ( unsigned long long  t )

inline

Write an unsigned long long value as a byte.

Parameters

t	Value to write

Returns

Number of bytes written

write() [13/14]

size_t Print::write ( unsigned long  t )

inline

Write an unsigned long value as a byte.

Parameters

t	Value to write

Returns

Number of bytes written

write() [14/14]

size_t Print::write ( unsigned short  t )

inline

Write an unsigned short value as a byte.

Parameters

t	Value to write

Returns

Number of bytes written

---

The documentation for this class was generated from the following file:

• docs/arduino/Print.h