Home > Support > Documentation

Print Functions

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

Functions

int rtxByteToHexChar (OSOCTET byte, char *buf, size_t bufsize)
 This function converts a byte value into its hex string equivalent.
void rtxPrintBoolean (const char *name, OSBOOL value)
 Prints a boolean value to stdout.
void rtxPrintDate (const char *name, const OSNumDateTime *pvalue)
 Prints a date value to stdout.
void rtxPrintTime (const char *name, const OSNumDateTime *pvalue)
 Prints a time value to stdout.
void rtxPrintDateTime (const char *name, const OSNumDateTime *pvalue)
 Prints a dateTime value to stdout.
void rtxPrintInteger (const char *name, OSINT32 value)
 Prints an integer value to stdout.
void rtxPrintInt64 (const char *name, OSINT64 value)
 Prints a 64-bit integer value to stdout.
void rtxPrintUnsigned (const char *name, OSUINT32 value)
 Prints an unsigned integer value to stdout.
void rtxPrintUInt64 (const char *name, OSUINT64 value)
 Prints an unsigned 64-bit integer value to stdout.
void rtxPrintHexStr (const char *name, OSUINT32 numocts, const OSOCTET *data)
 This function prints the value of a binary string in hex format to standard output.
void rtxPrintHexBinary (const char *name, OSUINT32 numocts, const OSOCTET *data)
 Prints an octet string value in hex binary format to stdout.
void rtxPrintCharStr (const char *name, const char *cstring)
 Prints an ASCII character string value to stdout.
void rtxPrintUTF8CharStr (const char *name, const OSUTF8CHAR *cstring)
 Prints a UTF-8 encoded character string value to stdout.
void rtxPrintUnicodeCharStr (const char *name, const OSUNICHAR *str, int nchars)
 This function prints a Unicode string to standard output.
void rtxPrintReal (const char *name, OSREAL value)
 Prints a REAL (float, double, decimal) value to stdout.
void rtxPrintNull (const char *name)
 Prints a NULL value to stdout.
void rtxPrintNVP (const char *name, const OSUTF8NVP *value)
 Prints a name-value pair to stdout.
int rtxPrintFile (const char *filename)
 This function prints the contents of a text file to stdout.
void rtxPrintIndent (void)
 This function prints indentation spaces to stdout.
void rtxPrintIncrIndent (void)
 This function increments the current indentation level.
void rtxPrintDecrIndent (void)
 This function decrements the current indentation level.
void rtxPrintCloseBrace (void)
 This function closes a braced region by decreasing the indent level, printing indent spaces, and printing the closing brace.
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.
void rtxHexDumpToFile (FILE *fp, const OSOCTET *data, OSUINT32 numocts)
 This function outputs a hexadecimal dump of the current buffer contents to a file.
void rtxHexDumpToFileEx (FILE *fp, const OSOCTET *data, OSUINT32 numocts, int bytesPerUnit)
 This function outputs a hexadecimal dump of the current buffer to a file, but it may output the dump as an array of bytes, words, or double words.
void rtxHexDump (const OSOCTET *data, OSUINT32 numocts)
 This function outputs a hexadecimal dump of the current buffer contents to stdout.
void rtxHexDumpEx (const OSOCTET *data, OSUINT32 numocts, int bytesPerUnit)
 This function outputs a hexadecimal dump of the current buffer contents to stdout, but it may display the dump as an array or bytes, words, or double words.
int rtxHexDumpToString (const OSOCTET *data, OSUINT32 numocts, char *buffer, int bufferIndex, int bufferSize)
 This function formats a hexadecimal dump of the current buffer contents to a string.
int rtxHexDumpToStringEx (const OSOCTET *data, OSUINT32 numocts, char *buffer, int bufferIndex, int bufferSize, int bytesPerUnit)
 This function formats a hexadecimal dump of the current buffer contents to a string, but it may output the dump as an array of bytes, words, or double words.

Detailed Description

These functions simply 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

int rtxByteToHexChar ( OSOCTET  byte,
char *  buf,
size_t  bufsize 
)

This function converts a byte value into its hex string equivalent.

Parameters:
byte Byte to format.
buf Output buffer.
bufsize Output buffer size.

void rtxHexDump ( const OSOCTET *  data,
OSUINT32  numocts 
)

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

Parameters:
data The pointer to a buffer to be displayed.
numocts The number of octets to be displayed.

void rtxHexDumpEx ( const OSOCTET *  data,
OSUINT32  numocts,
int  bytesPerUnit 
)

This function outputs a hexadecimal dump of the current buffer contents to stdout, but it may display the dump as an array or bytes, words, or double words.

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

void rtxHexDumpToFile ( FILE *  fp,
const OSOCTET *  data,
OSUINT32  numocts 
)

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

Parameters:
fp A pointer to FILE structure. The file should be opened for writing.
data The pointer to a buffer to be displayed.
numocts The number of octets to be displayed

void rtxHexDumpToFileEx ( FILE *  fp,
const OSOCTET *  data,
OSUINT32  numocts,
int  bytesPerUnit 
)

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

Parameters:
fp A pointer to FILE structure. The file should be opened for writing.
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).

int rtxHexDumpToString ( const OSOCTET *  data,
OSUINT32  numocts,
char *  buffer,
int  bufferIndex,
int  bufferSize 
)

This function formats a hexadecimal dump of the current buffer contents to a string.

Parameters:
data The pointer to a buffer to be displayed.
numocts The number of octets to be displayed.
buffer The destination string buffer.
bufferIndex The starting position in the destination buffer. The formatting of the dump will begin at this position.
bufferSize The total size of the destination buffer.
Returns:
The length of the final string.

int rtxHexDumpToStringEx ( const OSOCTET *  data,
OSUINT32  numocts,
char *  buffer,
int  bufferIndex,
int  bufferSize,
int  bytesPerUnit 
)

This function formats a hexadecimal dump of the current buffer contents to a string, but it may output the dump as an array of bytes, words, or double words.

Parameters:
data The pointer to a buffer to be displayed.
numocts The number of octets to be displayed.
buffer The destination string buffer.
bufferIndex The starting position in the destination buffer. The formatting of the dump will begin at this position.
bufferSize The total size of the destination buffer.
bytesPerUnit The number of bytes in one unit. May be 1 (byte), 2 (word), or 4 (double word).
Returns:
The length of the final string.

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.

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.

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.

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.

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.

void rtxPrintHexBinary ( const char *  name,
OSUINT32  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.

void rtxPrintHexStr ( 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:
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.

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.

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.

void rtxPrintNull ( const char *  name  ) 

Prints a NULL value to stdout.

Parameters:
name The name of the variable to print.

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.

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.

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.

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.

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

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.

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.