Print Class Reference

Arduino-compatible text output base class. A subclass provides write(uint8_t); everything else is built on it. More...

#include <Print.h>

Inheritance diagram for Print:

Public Member Functions
	Print ()
	Constructor: no write error.
virtual	~Print ()
	Virtual destructor.
int	getWriteError ()
void	clearWriteError ()
	Clear the write-error flag.
virtual size_t	write (uint8_t c)=0
size_t	write (const char *str)
virtual size_t	write (const uint8_t *buffer, size_t size)
	Write a buffer of bytes.
size_t	write (const char *buffer, size_t size)
virtual int	availableForWrite ()
virtual void	flush ()
	Wait for pending output to finish (no-op by default).
size_t	print (const __FlashStringHelper *ifsh)
	Print a flash-resident string, e.g. print(F("text")).
size_t	print (const String &s)
	Print a String.
size_t	print (const char str[])
	Print a NUL-terminated string.
size_t	print (char c)
	Print one character.
size_t	print (unsigned char b, int base=DEC)
	Print an unsigned char as a number.
size_t	print (int n, int base=DEC)
	Print an int.
size_t	print (unsigned int n, int base=DEC)
	Print an unsigned int.
size_t	print (long n, int base=DEC)
	Print a long.
size_t	print (unsigned long n, int base=DEC)
	Print an unsigned long.
size_t	print (double n, int digits=2)
	Print a floating-point number.
size_t	println (const __FlashStringHelper *ifsh)
	Print, followed by a line ending (CR LF), a flash-resident string, e.g. print(F("text")).
size_t	println (const String &s)
	Print, followed by a line ending (CR LF), a String.
size_t	println (const char str[])
	Print, followed by a line ending (CR LF), a NUL-terminated string.
size_t	println (char c)
	Print, followed by a line ending (CR LF), one character.
size_t	println (unsigned char b, int base=DEC)
	Print, followed by a line ending (CR LF), an unsigned char as a number.
size_t	println (int n, int base=DEC)
	Print, followed by a line ending (CR LF), an int.
size_t	println (unsigned int n, int base=DEC)
	Print, followed by a line ending (CR LF), an unsigned int.
size_t	println (long n, int base=DEC)
	Print, followed by a line ending (CR LF), a long.
size_t	println (unsigned long n, int base=DEC)
	Print, followed by a line ending (CR LF), an unsigned long.
size_t	println (double n, int digits=2)
	Print, followed by a line ending (CR LF), a floating-point number.
size_t	println (void)
	Print just a line ending (CR LF).

Protected Member Functions
void	setWriteError (int err=1)

Detailed Description

Arduino-compatible text output base class. A subclass provides write(uint8_t); everything else is built on it.

Definition at line 38 of file Print.h.

Constructor & Destructor Documentation

Print()

Print::Print ( )

inline

Constructor: no write error.

Definition at line 41 of file Print.h.

~Print()

virtual Print::~Print ( )

inlinevirtual

Virtual destructor.

Definition at line 43 of file Print.h.

Member Function Documentation

availableForWrite()

virtual int Print::availableForWrite ( )

inlinevirtual

Returns

Bytes that can be written without blocking (0 = unknown).

Definition at line 70 of file Print.h.

clearWriteError()

void Print::clearWriteError ( )

inline

Clear the write-error flag.

Definition at line 48 of file Print.h.

References setWriteError().

flush()

virtual void Print::flush ( )

inlinevirtual

Wait for pending output to finish (no-op by default).

Definition at line 72 of file Print.h.

getWriteError()

int Print::getWriteError ( )

inline

Returns

Non-zero if a write error occurred.

Definition at line 46 of file Print.h.

print() [1/10]

size_t Print::print

(

char

c

)

Print one character.

Parameters

c	The value to print

Returns

Bytes written.

Definition at line 53 of file Print.cpp.

References write().

print() [2/10]

size_t Print::print

(

const __FlashStringHelper *

ifsh

)

Print a flash-resident string, e.g. print(F("text")).

Parameters

ifsh	The value to print

Returns

Bytes written.

Definition at line 30 of file Print.cpp.

References print().

Referenced by Adafruit_GFX_Button::drawButton(), print(), print(), print(), print(), println(), println(), println(), println(), println(), println(), println(), println(), println(), and println().

print() [3/10]

size_t Print::print

(

const char

str[]

)

Print a NUL-terminated string.

Parameters

str	The value to print

Returns

Bytes written.

Definition at line 46 of file Print.cpp.

References write().

print() [4/10]

size_t Print::print

(

const String &

s

)

Print a String.

Parameters

s	The value to print

Returns

Bytes written.

Definition at line 39 of file Print.cpp.

References String::c_str(), String::length(), and write().

print() [5/10]

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

Print a floating-point number.

Parameters

n	The value to print
digits	Digits after the decimal point

Returns

Bytes written.

Definition at line 115 of file Print.cpp.

print() [6/10]

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

Print an int.

Parameters

n	The value to print
base	Number base: DEC, HEX, OCT or BIN

Returns

Bytes written.

Definition at line 71 of file Print.cpp.

References print().

print() [7/10]

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

Print a long.

Parameters

n	The value to print
base	Number base: DEC, HEX, OCT or BIN

Returns

Bytes written.

Definition at line 89 of file Print.cpp.

References print(), and write().

print() [8/10]

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

Print an unsigned char as a number.

Parameters

b	The value to print
base	Number base: DEC, HEX, OCT or BIN

Returns

Bytes written.

Definition at line 61 of file Print.cpp.

References print().

print() [9/10]

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

Print an unsigned int.

Parameters

n	The value to print
base	Number base: DEC, HEX, OCT or BIN

Returns

Bytes written.

Definition at line 79 of file Print.cpp.

References print().

Referenced by print().

print() [10/10]

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

Print an unsigned long.

Parameters

n	The value to print
base	Number base: DEC, HEX, OCT or BIN

Returns

Bytes written.

Definition at line 105 of file Print.cpp.

References write().

println() [1/11]

size_t Print::println

(

char

c

)

Print, followed by a line ending (CR LF), one character.

Parameters

c	The value to print

Returns

Bytes written.

Definition at line 151 of file Print.cpp.

References print(), and println().

println() [2/11]

size_t Print::println

(

const __FlashStringHelper *

ifsh

)

Print, followed by a line ending (CR LF), a flash-resident string, e.g. print(F("text")).

Parameters

ifsh	The value to print

Returns

Bytes written.

Definition at line 128 of file Print.cpp.

References print(), and println().

println() [3/11]

size_t Print::println

(

const char

c[]

)

Print, followed by a line ending (CR LF), a NUL-terminated string.

Parameters

c	The value to print

Returns

Bytes written.

Definition at line 144 of file Print.cpp.

References print(), and println().

println() [4/11]

size_t Print::println

(

const String &

s

)

Print, followed by a line ending (CR LF), a String.

Parameters

s	The value to print

Returns

Bytes written.

Definition at line 137 of file Print.cpp.

References print(), and println().

println() [5/11]

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

Print, followed by a line ending (CR LF), a floating-point number.

Parameters

num	The value to print
digits	Digits after the decimal point

Returns

Bytes written.

Definition at line 205 of file Print.cpp.

References print(), and println().

println() [6/11]

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

Print, followed by a line ending (CR LF), an int.

Parameters

num	The value to print
base	Number base: DEC, HEX, OCT or BIN

Returns

Bytes written.

Definition at line 169 of file Print.cpp.

References print(), and println().

println() [7/11]

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

Print, followed by a line ending (CR LF), a long.

Parameters

num	The value to print
base	Number base: DEC, HEX, OCT or BIN

Returns

Bytes written.

Definition at line 187 of file Print.cpp.

References print(), and println().

println() [8/11]

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

Print, followed by a line ending (CR LF), an unsigned char as a number.

Parameters

b	The value to print
base	Number base: DEC, HEX, OCT or BIN

Returns

Bytes written.

Definition at line 159 of file Print.cpp.

References print(), and println().

println() [9/11]

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

Print, followed by a line ending (CR LF), an unsigned int.

Parameters

num	The value to print
base	Number base: DEC, HEX, OCT or BIN

Returns

Bytes written.

Definition at line 177 of file Print.cpp.

References print(), and println().

println() [10/11]

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

Print, followed by a line ending (CR LF), an unsigned long.

Parameters

num	The value to print
base	Number base: DEC, HEX, OCT or BIN

Returns

Bytes written.

Definition at line 195 of file Print.cpp.

References print(), and println().

println() [11/11]

size_t Print::println

(

void

)

Print just a line ending (CR LF).

Returns

Bytes written.

Definition at line 121 of file Print.cpp.

References write().

Referenced by println(), println(), println(), println(), println(), println(), println(), println(), println(), and println().

setWriteError()

void Print::setWriteError ( int err = 1 )

inlineprotected

Set the write-error flag.

Parameters

err	Non-zero to flag an error (default 1)

Definition at line 100 of file Print.h.

Referenced by clearWriteError().

write() [1/4]

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

inline

Write a buffer of characters.

Parameters

buffer	Characters to write
size	Number of characters

Returns

Bytes written.

Definition at line 65 of file Print.h.

References write().

write() [2/4]

size_t Print::write ( const char * str )

inline

Write a NUL-terminated string.

Parameters

str	The string to write (nullptr writes nothing)

Returns

Bytes written.

Definition at line 57 of file Print.h.

References write().

write() [3/4]

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

virtual

Write a buffer of bytes.

Parameters

buffer	Bytes to write
size	Number of bytes

Returns

Bytes written.

Reimplemented in Adafruit_GFX, and Adafruit_RA8875.

Definition at line 14 of file Print.cpp.

References write().

write() [4/4]

virtual size_t Print::write ( uint8_t c )

pure virtual

Write one byte; the only function a subclass must provide.

Parameters

c	The byte to write

Returns

Number of bytes written (0 on failure).

Implemented in Adafruit_RA8875, Adafruit_GFX, and Adafruit_GFX.

Referenced by print(), print(), print(), print(), print(), println(), write(), write(), and write().

---

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

• Print.h
• Print.cpp