Print Functions

These functions print the output in a "name=value" format. More...

Functions
EXTERNRT void	rtxPrintBoolean (const char *name, OSBOOL value)
	Prints a boolean value to stdout. More...
EXTERNRT void	rtxPrintDate (const char *name, const OSNumDateTime *pvalue)
	Prints a date value to stdout. More...
EXTERNRT void	rtxPrintTime (const char *name, const OSNumDateTime *pvalue)
	Prints a time value to stdout. More...
EXTERNRT void	rtxPrintDateTime (const char *name, const OSNumDateTime *pvalue)
	Prints a dateTime value to stdout. More...
EXTERNRT void	rtxPrintInteger (const char *name, OSINT32 value)
	Prints an integer value to stdout. More...
EXTERNRT void	rtxPrintInt64 (const char *name, OSINT64 value)
	Prints a 64-bit integer value to stdout. More...
EXTERNRT void	rtxPrintIpv4Addr (const char *name, OSSIZE numocts, const OSOCTET *data)
	This function prints the value of a binary string in IPv4 address format to standard output. More...
EXTERNRT void	rtxPrintIpv6Addr (const char *name, OSSIZE numocts, const OSOCTET *data)
	This function prints the value of a binary string in IPv6 address format to standard output. More...
EXTERNRT void	rtxPrintTBCDStr (const char *name, OSSIZE numocts, const OSOCTET *data)
	This function prints the value of a binary string in TBCD format to standard output. More...
EXTERNRT void	rtxPrintText (const char *name, OSSIZE numocts, const OSOCTET *data)
	This function prints the value of a binary string in ASCII text format to standard output. More...
EXTERNRT void	rtxPrintUnsigned (const char *name, OSUINT32 value)
	Prints an unsigned integer value to stdout. More...
EXTERNRT void	rtxPrintUInt64 (const char *name, OSUINT64 value)
	Prints an unsigned 64-bit integer value to stdout. More...
EXTERNRT void	rtxPrintHexStr (const char *name, OSSIZE numocts, const OSOCTET *data)
	This function prints the value of a binary string in hex format to standard output. More...
EXTERNRT void	rtxPrintHexStrPlain (const char *name, OSSIZE numocts, const OSOCTET *data)
	This function prints the value of a binary string in hex format to standard output. More...
EXTERNRT void	rtxPrintHexStrNoAscii (const char *name, OSSIZE numocts, const OSOCTET *data)
	This function prints the value of a binary string in hex format to standard output. More...
EXTERNRT void	rtxPrintHexBinary (const char *name, OSSIZE numocts, const OSOCTET *data)
	Prints an octet string value in hex binary format to stdout. More...
EXTERNRT void	rtxPrintCharStr (const char *name, const char *cstring)
	Prints an ASCII character string value to stdout. More...
EXTERNRT void	rtxPrintUTF8CharStr (const char *name, const OSUTF8CHAR *cstring)
	Prints a UTF-8 encoded character string value to stdout. More...
EXTERNRT void	rtxPrintUnicodeCharStr (const char *name, const OSUNICHAR *str, int nchars)
	This function prints a Unicode string to standard output. More...
EXTERNRT void	rtxPrintReal (const char *name, OSREAL value)
	Prints a REAL (float, double, decimal) value to stdout. More...
EXTERNRT void	rtxPrintNull (const char *name)
	Prints a NULL value to stdout. More...
EXTERNRT void	rtxPrintNVP (const char *name, const OSUTF8NVP *value)
	Prints a name-value pair to stdout. More...
EXTERNRT void	rtxPrintArrayNVP (const char *name, OSSIZE subscript, const OSUTF8NVP *value)
	Prints a name-value pair to stdout. More...
EXTERNRT int	rtxPrintFile (const char *filename)
	This function prints the contents of a text file to stdout. More...
EXTERNRT void	rtxPrintIndent (OSVOIDARG)
	This function prints indentation spaces to stdout.
EXTERNRT void	rtxPrintIncrIndent (OSVOIDARG)
	This function increments the current indentation level.
EXTERNRT void	rtxPrintDecrIndent (OSVOIDARG)
	This function decrements the current indentation level.
EXTERNRT void	rtxPrintCloseBrace (OSVOIDARG)
	This function closes a braced region by decreasing the indent level, printing indent spaces, and printing the closing brace.
EXTERNRT void	rtxPrintOpenBrace (const char *)
	This function opens a braced region by printing indent spaces, printing the name and opening brace, and increasing the indent level.
EXTERNRT const char *	rtxGetArrayElemName (char *buffer, OSSIZE bufsize, const char *name, OSSIZE subscript)
	This function returns an array element name in the form of 'name[subscript]' in the given character array buffer. More...

Detailed Description

These functions print the output in a "name=value" format.

The value format is obtained by calling one of the ToString functions with the given value.

Function Documentation

rtxGetArrayElemName()

EXTERNRT const char* rtxGetArrayElemName	(	char *	buffer,
		OSSIZE	bufsize,
		const char *	name,
		OSSIZE	subscript
	)

This function returns an array element name in the form of 'name[subscript]' in the given character array buffer.

Parameters

buffer	Character buffer into which formed name is written
bufsize	Size of character buffer
name	Element name
subscript	Array subscript

Returns

Pointer to name buffer

rtxPrintArrayNVP()

EXTERNRT void rtxPrintArrayNVP	(	const char *	name,
		OSSIZE	subscript,
		const OSUTF8NVP *	value
	)

Prints a name-value pair to stdout.

In this case, the name is formed using the name and subscript arguments in the form of "name[subscript]".

Parameters

name	The name of the variable to print.
subscript	Array subscript value.
value	A pointer to name-value pair structure to print.

rtxPrintBoolean()

EXTERNRT void rtxPrintBoolean	(	const char *	name,
		OSBOOL	value
	)

Prints a boolean value to stdout.

Parameters

name	The name of the variable to print.
value	Boolean value to print.

rtxPrintCharStr()

EXTERNRT void rtxPrintCharStr	(	const char *	name,
		const char *	cstring
	)

Prints an ASCII character string value to stdout.

Parameters

name	The name of the variable to print.
cstring	A pointer to the character string to be printed.

rtxPrintDate()

EXTERNRT void rtxPrintDate	(	const char *	name,
		const OSNumDateTime *	pvalue
	)

Prints a date value to stdout.

Parameters

name	Name of the variable to print.
pvalue	Pointer to a structure that holds numeric DateTime value to print.

rtxPrintDateTime()

EXTERNRT void rtxPrintDateTime	(	const char *	name,
		const OSNumDateTime *	pvalue
	)

Prints a dateTime value to stdout.

Parameters

name	Name of the variable to print.
pvalue	Pointer to a structure that holds numeric DateTime value to print.

rtxPrintFile()

EXTERNRT int rtxPrintFile

(

const char *

filename

)

This function prints the contents of a text file to stdout.

Parameters

filename

The name of the text file to print.

Returns

Status of operation, 0 if success.

rtxPrintHexBinary()

EXTERNRT void rtxPrintHexBinary	(	const char *	name,
		OSSIZE	numocts,
		const OSOCTET *	data
	)

Prints an octet string value in hex binary format to stdout.

Parameters

name	The name of the variable to print.
numocts	The number of octets to be printed.
data	A pointer to the data to be printed.

rtxPrintHexStr()

EXTERNRT void rtxPrintHexStr	(	const char *	name,
		OSSIZE	numocts,
		const OSOCTET *	data
	)

This function prints the value of a binary string in hex format to standard output.

If the string is 32 bytes or less, it is printed on a single line with a '0x' prefix. If longer, a formatted hex dump showing both hex and ascii codes is done.

Parameters

name	The name of the variable to print.
numocts	The number of octets to be printed.
data	A pointer to the data to be printed.

rtxPrintHexStrNoAscii()

EXTERNRT void rtxPrintHexStrNoAscii	(	const char *	name,
		OSSIZE	numocts,
		const OSOCTET *	data
	)

This function prints the value of a binary string in hex format to standard output.

In contrast to rtxPrintHexStr, it never contains an ASCII dump.

Parameters

name	The name of the variable to print.
numocts	The number of octets to be printed.
data	A pointer to the data to be printed.

rtxPrintHexStrPlain()

EXTERNRT void rtxPrintHexStrPlain	(	const char *	name,
		OSSIZE	numocts,
		const OSOCTET *	data
	)

This function prints the value of a binary string in hex format to standard output.

In contrast to rtxPrintHexStr, it is always printed on a single line with a '0x' prefix.

Parameters

name	The name of the variable to print.
numocts	The number of octets to be printed.
data	A pointer to the data to be printed.

rtxPrintInt64()

EXTERNRT void rtxPrintInt64	(	const char *	name,
		OSINT64	value
	)

Prints a 64-bit integer value to stdout.

Parameters

name	The name of the variable to print.
value	64-bit integer value to print.

rtxPrintInteger()

EXTERNRT void rtxPrintInteger	(	const char *	name,
		OSINT32	value
	)

Prints an integer value to stdout.

Parameters

name	The name of the variable to print.
value	Integer value to print.

rtxPrintIpv4Addr()

EXTERNRT void rtxPrintIpv4Addr	(	const char *	name,
		OSSIZE	numocts,
		const OSOCTET *	data
	)

This function prints the value of a binary string in IPv4 address format to standard output.

Parameters

name	The name of the variable to print.
numocts	The number of octets to be printed.
data	A pointer to the data to be printed.

rtxPrintIpv6Addr()

EXTERNRT void rtxPrintIpv6Addr	(	const char *	name,
		OSSIZE	numocts,
		const OSOCTET *	data
	)

This function prints the value of a binary string in IPv6 address format to standard output.

Parameters

name	The name of the variable to print.
numocts	The number of octets to be printed.
data	A pointer to the data to be printed.

rtxPrintNull()

EXTERNRT void rtxPrintNull

(

const char *

name

)

Prints a NULL value to stdout.

Parameters

name	The name of the variable to print.

rtxPrintNVP()

EXTERNRT void rtxPrintNVP	(	const char *	name,
		const OSUTF8NVP *	value
	)

Prints a name-value pair to stdout.

Parameters

name	The name of the variable to print.
value	A pointer to name-value pair structure to print.

rtxPrintReal()

EXTERNRT void rtxPrintReal	(	const char *	name,
		OSREAL	value
	)

Prints a REAL (float, double, decimal) value to stdout.

Parameters

name	The name of the variable to print.
value	REAL value to print.

rtxPrintTBCDStr()

EXTERNRT void rtxPrintTBCDStr	(	const char *	name,
		OSSIZE	numocts,
		const OSOCTET *	data
	)

This function prints the value of a binary string in TBCD format to standard output.

Parameters

name	The name of the variable to print.
numocts	The number of octets to be printed.
data	A pointer to the data to be printed.

rtxPrintText()

EXTERNRT void rtxPrintText	(	const char *	name,
		OSSIZE	numocts,
		const OSOCTET *	data
	)

This function prints the value of a binary string in ASCII text format to standard output.

Parameters

name	The name of the variable to print.
numocts	The number of octets to be printed.
data	A pointer to the data to be printed.

rtxPrintTime()

EXTERNRT void rtxPrintTime	(	const char *	name,
		const OSNumDateTime *	pvalue
	)

Prints a time value to stdout.

Parameters

name	Name of the variable to print.
pvalue	Pointer to a structure that holds numeric DateTime value to print.

rtxPrintUInt64()

EXTERNRT void rtxPrintUInt64	(	const char *	name,
		OSUINT64	value
	)

Prints an unsigned 64-bit integer value to stdout.

Parameters

name	The name of the variable to print.
value	Unsigned 64-bit integer value to print.

rtxPrintUnicodeCharStr()

EXTERNRT void rtxPrintUnicodeCharStr	(	const char *	name,
		const OSUNICHAR *	str,
		int	nchars
	)

This function prints a Unicode string to standard output.

Characters in the string that are within the normal Ascii range are printed as single characters. Characters outside the Ascii range are printed as 4-byte hex codes (0xnnnn).

Parameters

name	The name of the variable to print.
str	Pointer to unicode sring to be printed. String is an array of C unsigned short data variables.
nchars	Number of characters in the string. If value is negative, string is assumed to be null-terminated (i.e. ends with a 0x0000 character).

rtxPrintUnsigned()

EXTERNRT void rtxPrintUnsigned	(	const char *	name,
		OSUINT32	value
	)

Prints an unsigned integer value to stdout.

Parameters

name	The name of the variable to print.
value	Unsigned integer value to print.

rtxPrintUTF8CharStr()

EXTERNRT void rtxPrintUTF8CharStr	(	const char *	name,
		const OSUTF8CHAR *	cstring
	)

Prints a UTF-8 encoded character string value to stdout.

Parameters

name	The name of the variable to print.
cstring	A pointer to the character string to be printed.