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.
EXTERNRT void	rtxPrintToStreamDate (OSCTXT pctxt, const char name, const OSNumDateTime *pvalue)
	Prints a date value to a print stream.
EXTERNRT void	rtxPrintToStreamTime (OSCTXT pctxt, const char name, const OSNumDateTime *pvalue)
	Prints a time value to a print stream.
EXTERNRT void	rtxPrintToStreamDateTime (OSCTXT pctxt, const char name, const OSNumDateTime *pvalue)
	Prints a dateTime value to a print stream.
EXTERNRT void	rtxPrintToStreamInteger (OSCTXT pctxt, const char name, OSINT32 value)
	Prints an integer value to a print stream.
EXTERNRT void	rtxPrintToStreamInt64 (OSCTXT pctxt, const char name, OSINT64 value)
	Prints a 64-bit integer value to a print stream.
EXTERNRT void	rtxPrintToStreamUnsigned (OSCTXT pctxt, const char name, OSUINT32 value)
	Prints an unsigned integer value to a print stream.
EXTERNRT void	rtxPrintToStreamUInt64 (OSCTXT pctxt, const char name, OSUINT64 value)
	Prints an unsigned 64-bit integer value to a print stream.
EXTERNRT void	rtxPrintToStreamHexStr (OSCTXT pctxt, const char name, OSUINT32 numocts, const OSOCTET *data)
	This function prints the value of a binary string in hex format to standard output.
EXTERNRT void	rtxPrintToStreamHexBinary (OSCTXT pctxt, const char name, OSUINT32 numocts, const OSOCTET *data)
	Prints an octet string value in hex binary format to a print stream.
EXTERNRT void	rtxPrintToStreamCharStr (OSCTXT pctxt, const char name, const char *cstring)
	Prints an ASCII character string value to a print stream.
EXTERNRT void	rtxPrintToStreamUTF8CharStr (OSCTXT pctxt, const char name, const OSUTF8CHAR *cstring)
	Prints a UTF-8 encoded character string value to a print stream.
EXTERNRT void	rtxPrintToStreamUnicodeCharStr (OSCTXT pctxt, const char name, const OSUNICHAR *str, int nchars)
	This function prints a Unicode string to standard output.
EXTERNRT void	rtxPrintToStreamReal (OSCTXT pctxt, const char name, OSREAL value)
	Prints a REAL (float, double, decimal) value to a print stream.
EXTERNRT void	rtxPrintToStreamNull (OSCTXT pctxt, const char name)
	Prints a NULL value to a print stream.
EXTERNRT void	rtxPrintToStreamNVP (OSCTXT pctxt, const char name, const OSUTF8NVP *value)
	Prints a name-value pair to a print stream.
EXTERNRT int	rtxPrintToStreamFile (OSCTXT pctxt, const char filename)
	This function prints the contents of a text file to a print stream.
EXTERNRT void	rtxPrintToStreamIndent (OSCTXT *pctxt)
	This function prints indentation spaces to a print stream.
EXTERNRT void	rtxPrintToStreamIncrIndent (void)
	This function increments the current indentation level.
EXTERNRT void	rtxPrintToStreamDecrIndent (void)
	This function decrements the current indentation level.
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, OSUINT32 numocts)
	This function outputs a hexadecimal dump of the current buffer contents to a print stream.
EXTERNRT void	rtxHexDumpToStreamEx (OSCTXT pctxt, const OSOCTET data, OSUINT32 numocts, int 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.

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

EXTERNRT void rtxHexDumpToStream	(	OSCTXT *	pctxt,
		const OSOCTET *	data,
		OSUINT32	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

EXTERNRT void rtxHexDumpToStreamEx	(	OSCTXT *	pctxt,
		const OSOCTET *	data,
		OSUINT32	numocts,
		int	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).

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.

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.

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.

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.

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.

EXTERNRT void rtxPrintToStreamHexBinary	(	OSCTXT *	pctxt,
		const char *	name,
		OSUINT32	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.

EXTERNRT void rtxPrintToStreamHexStr	(	OSCTXT *	pctxt,
		const char *	name,
		OSUINT32	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.

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.

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.

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.

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.

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.

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.

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.

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).

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.

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.