Print-To-Stream Functions

These functions print typed data in a "name=value" format. More...

Functions
EXTERNRT void	rtxPrintToStreamBoolean (OSCTXT *pctxt, const char *name, OSBOOL value)
	Prints a boolean value to a print stream. More...
EXTERNRT void	rtxPrintToStreamDate (OSCTXT *pctxt, const char *name, const OSNumDateTime *pvalue)
	Prints a date value to a print stream. More...
EXTERNRT void	rtxPrintToStreamTime (OSCTXT *pctxt, const char *name, const OSNumDateTime *pvalue)
	Prints a time value to a print stream. More...
EXTERNRT void	rtxPrintToStreamDateTime (OSCTXT *pctxt, const char *name, const OSNumDateTime *pvalue)
	Prints a dateTime value to a print stream. More...
EXTERNRT void	rtxPrintToStreamInteger (OSCTXT *pctxt, const char *name, OSINT32 value)
	Prints an integer value to a print stream. More...
EXTERNRT void	rtxPrintToStreamInt64 (OSCTXT *pctxt, const char *name, OSINT64 value)
	Prints a 64-bit integer value to a print stream. More...
EXTERNRT void	rtxPrintToStreamUnsigned (OSCTXT *pctxt, const char *name, OSUINT32 value)
	Prints an unsigned integer value to a print stream. More...
EXTERNRT void	rtxPrintToStreamUInt64 (OSCTXT *pctxt, const char *name, OSUINT64 value)
	Prints an unsigned 64-bit integer value to a print stream. More...
EXTERNRT void	rtxPrintToStreamHexStr (OSCTXT *pctxt, 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	rtxPrintToStreamHexStrPlain (OSCTXT *pctxt, 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	rtxPrintToStreamHexStrNoAscii (OSCTXT *pctxt, 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	rtxPrintToStreamHexBinary (OSCTXT *pctxt, const char *name, OSSIZE numocts, const OSOCTET *data)
	Prints an octet string value in hex binary format to a print stream. More...
EXTERNRT void	rtxPrintToStreamCharStr (OSCTXT *pctxt, const char *name, const char *cstring)
	Prints an ASCII character string value to a print stream. More...
EXTERNRT void	rtxPrintToStreamUTF8CharStr (OSCTXT *pctxt, const char *name, const OSUTF8CHAR *cstring)
	Prints a UTF-8 encoded character string value to a print stream. More...
EXTERNRT void	rtxPrintToStreamUnicodeCharStr (OSCTXT *pctxt, const char *name, const OSUNICHAR *str, int nchars)
	This function prints a Unicode string to standard output. More...
EXTERNRT void	rtxPrintToStreamReal (OSCTXT *pctxt, const char *name, OSREAL value)
	Prints a REAL (float, double, decimal) value to a print stream. More...
EXTERNRT void	rtxPrintToStreamNull (OSCTXT *pctxt, const char *name)
	Prints a NULL value to a print stream. More...
EXTERNRT void	rtxPrintToStreamNVP (OSCTXT *pctxt, const char *name, const OSUTF8NVP *value)
	Prints a name-value pair to a print stream. More...
EXTERNRT int	rtxPrintToStreamFile (OSCTXT *pctxt, const char *filename)
	This function prints the contents of a text file to a print stream. More...
EXTERNRT void	rtxPrintToStreamIndent (OSCTXT *pctxt)
	This function prints indentation spaces to a print stream.
EXTERNRT void	rtxPrintToStreamIncrIndent (OSCTXT *pctxt)
	This function increments the current indentation level. More...
EXTERNRT void	rtxPrintToStreamDecrIndent (OSCTXT *pctxt)
	This function decrements the current indentation level. More...
EXTERNRT void	rtxPrintToStreamCloseBrace (OSCTXT *pctxt)
	This function closes a braced region by decreasing the indent level, printing indent spaces, and printing the closing brace.
EXTERNRT void	rtxPrintToStreamOpenBrace (OSCTXT *pctxt, const char *)
	This function opens a braced region by printing indent spaces, printing the name and opening brace, and increasing the indent level.
EXTERNRT void	rtxHexDumpToStream (OSCTXT *pctxt, const OSOCTET *data, OSSIZE numocts)
	This function outputs a hexadecimal dump of the current buffer contents to a print stream. More...
EXTERNRT void	rtxHexDumpToStreamEx (OSCTXT *pctxt, const OSOCTET *data, OSSIZE numocts, OSSIZE bytesPerUnit)
	This function outputs a hexadecimal dump of the current buffer to a print stream, but it may output the dump as an array of bytes, words, or double words. More...
EXTERNRT void	rtxHexDumpToStreamExNoAscii (OSCTXT *pctxt, const OSOCTET *data, OSSIZE numocts, OSSIZE bytesPerUnit)
	This function outputs a formatted hexadecimal dump of the current buffer to a print stream. More...

Detailed Description

These functions print typed data in a "name=value" format.

The output is redirected to the print stream defined within the context or to a global print stream. Print streams are set using the rtxSetPrintStream or rtxSetGlobalPrintStream function.

Function Documentation

rtxHexDumpToStream()

EXTERNRT void rtxHexDumpToStream	(	OSCTXT *	pctxt,
		const OSOCTET *	data,
		OSSIZE	numocts
	)

This function outputs a hexadecimal dump of the current buffer contents to a print stream.

Parameters

pctxt	A pointer to a context structure.
data	The pointer to a buffer to be displayed.
numocts	The number of octets to be displayed

rtxHexDumpToStreamEx()

EXTERNRT void rtxHexDumpToStreamEx	(	OSCTXT *	pctxt,
		const OSOCTET *	data,
		OSSIZE	numocts,
		OSSIZE	bytesPerUnit
	)

This function outputs a hexadecimal dump of the current buffer to a print stream, but it may output the dump as an array of bytes, words, or double words.

Parameters

pctxt	A pointer to a context structure.
data	The pointer to a buffer to be displayed.
numocts	The number of octets to be displayed.
bytesPerUnit	The number of bytes in one unit. May be 1 (byte), 2 (word), or 4 (double word).

rtxHexDumpToStreamExNoAscii()

EXTERNRT void rtxHexDumpToStreamExNoAscii	(	OSCTXT *	pctxt,
		const OSOCTET *	data,
		OSSIZE	numocts,
		OSSIZE	bytesPerUnit
	)

This function outputs a formatted hexadecimal dump of the current buffer to a print stream.

It outputs the dump as an array of bytes, words, or double words. It does not output any ASCII equivalent.

Parameters

pctxt	A pointer to a context structure.
data	The pointer to a buffer to be displayed.
numocts	The number of octets to be displayed.
bytesPerUnit	The number of bytes in one unit. May be 1 (byte), 2 (word), or 4 (double word).

rtxPrintToStreamBoolean()

EXTERNRT void rtxPrintToStreamBoolean	(	OSCTXT *	pctxt,
		const char *	name,
		OSBOOL	value
	)

Prints a boolean value to a print stream.

Parameters

pctxt	A pointer to a context structure.
name	The name of the variable to print.
value	Boolean value to print.

rtxPrintToStreamCharStr()

EXTERNRT void rtxPrintToStreamCharStr	(	OSCTXT *	pctxt,
		const char *	name,
		const char *	cstring
	)

Prints an ASCII character string value to a print stream.

Parameters

pctxt	A pointer to a context structure.
name	The name of the variable to print.
cstring	A pointer to the character string to be printed.

rtxPrintToStreamDate()

EXTERNRT void rtxPrintToStreamDate	(	OSCTXT *	pctxt,
		const char *	name,
		const OSNumDateTime *	pvalue
	)

Prints a date value to a print stream.

Parameters

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

rtxPrintToStreamDateTime()

EXTERNRT void rtxPrintToStreamDateTime	(	OSCTXT *	pctxt,
		const char *	name,
		const OSNumDateTime *	pvalue
	)

Prints a dateTime value to a print stream.

Parameters

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

rtxPrintToStreamDecrIndent()

EXTERNRT void rtxPrintToStreamDecrIndent

(

OSCTXT *

pctxt

)

This function decrements the current indentation level.

Parameters

pctxt

A pointer to a context data structure that holds the print stream.

rtxPrintToStreamFile()

EXTERNRT int rtxPrintToStreamFile	(	OSCTXT *	pctxt,
		const char *	filename
	)

This function prints the contents of a text file to a print stream.

Parameters

pctxt	A pointer to a context structure.
filename	The name of the text file to print.

Returns

Status of operation, 0 if success.

rtxPrintToStreamHexBinary()

EXTERNRT void rtxPrintToStreamHexBinary	(	OSCTXT *	pctxt,
		const char *	name,
		OSSIZE	numocts,
		const OSOCTET *	data
	)

Prints an octet string value in hex binary format to a print stream.

Parameters

pctxt	A pointer to a context structure.
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.

rtxPrintToStreamHexStr()

EXTERNRT void rtxPrintToStreamHexStr	(	OSCTXT *	pctxt,
		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

pctxt	A pointer to a context structure.
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.

rtxPrintToStreamHexStrNoAscii()

EXTERNRT void rtxPrintToStreamHexStrNoAscii	(	OSCTXT *	pctxt,
		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 rtxPrintToStreamHexStr, it contains no ASCII output, but instead is a formatted block of hex text printed on multiple lines if needed.

Parameters

pctxt	A pointer to a context structure.
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.

rtxPrintToStreamHexStrPlain()

EXTERNRT void rtxPrintToStreamHexStrPlain	(	OSCTXT *	pctxt,
		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 rtxPrintToStreamHexStr, it is always printed on a single line with a '0x' prefix.

Parameters

pctxt	A pointer to a context structure.
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.

rtxPrintToStreamIncrIndent()

EXTERNRT void rtxPrintToStreamIncrIndent

(

OSCTXT *

pctxt

)

This function increments the current indentation level.

Parameters

pctxt

A pointer to a context data structure that holds the print stream.

rtxPrintToStreamInt64()

EXTERNRT void rtxPrintToStreamInt64	(	OSCTXT *	pctxt,
		const char *	name,
		OSINT64	value
	)

Prints a 64-bit integer value to a print stream.

Parameters

pctxt	A pointer to a context structure.
name	The name of the variable to print.
value	64-bit integer value to print.

rtxPrintToStreamInteger()

EXTERNRT void rtxPrintToStreamInteger	(	OSCTXT *	pctxt,
		const char *	name,
		OSINT32	value
	)

Prints an integer value to a print stream.

Parameters

pctxt	A pointer to a context structure.
name	The name of the variable to print.
value	Integer value to print.

rtxPrintToStreamNull()

EXTERNRT void rtxPrintToStreamNull	(	OSCTXT *	pctxt,
		const char *	name
	)

Prints a NULL value to a print stream.

Parameters

pctxt	A pointer to a context structure.
name	The name of the variable to print.

rtxPrintToStreamNVP()

EXTERNRT void rtxPrintToStreamNVP	(	OSCTXT *	pctxt,
		const char *	name,
		const OSUTF8NVP *	value
	)

Prints a name-value pair to a print stream.

Parameters

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

rtxPrintToStreamReal()

EXTERNRT void rtxPrintToStreamReal	(	OSCTXT *	pctxt,
		const char *	name,
		OSREAL	value
	)

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

Parameters

pctxt	A pointer to a context structure.
name	The name of the variable to print.
value	REAL value to print.

rtxPrintToStreamTime()

EXTERNRT void rtxPrintToStreamTime	(	OSCTXT *	pctxt,
		const char *	name,
		const OSNumDateTime *	pvalue
	)

Prints a time value to a print stream.

Parameters

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

rtxPrintToStreamUInt64()

EXTERNRT void rtxPrintToStreamUInt64	(	OSCTXT *	pctxt,
		const char *	name,
		OSUINT64	value
	)

Prints an unsigned 64-bit integer value to a print stream.

Parameters

pctxt	A pointer to a context structure.
name	The name of the variable to print.
value	Unsigned 64-bit integer value to print.

rtxPrintToStreamUnicodeCharStr()

EXTERNRT void rtxPrintToStreamUnicodeCharStr	(	OSCTXT *	pctxt,
		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

pctxt	A pointer to a context structure.
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).

rtxPrintToStreamUnsigned()

EXTERNRT void rtxPrintToStreamUnsigned	(	OSCTXT *	pctxt,
		const char *	name,
		OSUINT32	value
	)

Prints an unsigned integer value to a print stream.

Parameters

pctxt	A pointer to a context structure.
name	The name of the variable to print.
value	Unsigned integer value to print.

rtxPrintToStreamUTF8CharStr()

EXTERNRT void rtxPrintToStreamUTF8CharStr	(	OSCTXT *	pctxt,
		const char *	name,
		const OSUTF8CHAR *	cstring
	)

Prints a UTF-8 encoded character string value to a print stream.

Parameters

pctxt	A pointer to a context structure.
name	The name of the variable to print.
cstring	A pointer to the character string to be printed.