ASN1C C/C++ Common Runtime  ASN1C v7.8.x
Functions
Print-To-Stream Functions

Functions

void rtxPrintToStreamBoolean (OSCTXT *pctxt, const char *name, OSBOOL value)
 
void rtxPrintToStreamDate (OSCTXT *pctxt, const char *name, const OSNumDateTime *pvalue)
 
void rtxPrintToStreamTime (OSCTXT *pctxt, const char *name, const OSNumDateTime *pvalue)
 
void rtxPrintToStreamDateTime (OSCTXT *pctxt, const char *name, const OSNumDateTime *pvalue)
 
void rtxPrintToStreamGYear (OSCTXT *pctxt, const char *name, const OSNumDateTime *pvalue)
 
void rtxPrintToStreamGYearMonth (OSCTXT *pctxt, const char *name, const OSNumDateTime *pvalue)
 
void rtxPrintToStreamGMonth (OSCTXT *pctxt, const char *name, const OSNumDateTime *pvalue)
 
void rtxPrintToStreamGMonthDay (OSCTXT *pctxt, const char *name, const OSNumDateTime *pvalue)
 
void rtxPrintToStreamGDay (OSCTXT *pctxt, const char *name, const OSNumDateTime *pvalue)
 
void rtxPrintToStreamInteger (OSCTXT *pctxt, const char *name, OSINT32 value)
 
void rtxPrintToStreamInt64 (OSCTXT *pctxt, const char *name, OSINT64 value)
 
void rtxPrintToStreamUnsigned (OSCTXT *pctxt, const char *name, OSUINT32 value)
 
void rtxPrintToStreamUInt64 (OSCTXT *pctxt, const char *name, OSUINT64 value)
 
void rtxPrintToStreamHexStr (OSCTXT *pctxt, const char *name, OSSIZE numocts, const OSOCTET *data)
 
void rtxPrintToStreamHexStrPlain (OSCTXT *pctxt, const char *name, OSSIZE numocts, const OSOCTET *data)
 
void rtxPrintToStreamHexStrNoAscii (OSCTXT *pctxt, const char *name, OSSIZE numocts, const OSOCTET *data)
 
void rtxPrintToStreamHexBinary (OSCTXT *pctxt, const char *name, OSSIZE numocts, const OSOCTET *data)
 
void rtxPrintToStreamCharStr (OSCTXT *pctxt, const char *name, const char *cstring)
 
void rtxPrintToStreamUTF8CharStr (OSCTXT *pctxt, const char *name, const OSUTF8CHAR *cstring)
 
void rtxPrintToStreamUnicodeCharStr (OSCTXT *pctxt, const char *name, const OSUNICHAR *str, int nchars)
 
void rtxPrintToStreamReal (OSCTXT *pctxt, const char *name, OSREAL value)
 
void rtxPrintToStreamNull (OSCTXT *pctxt, const char *name)
 
void rtxPrintToStreamNVP (OSCTXT *pctxt, const char *name, const OSUTF8NVP *value)
 
int rtxPrintToStreamFile (OSCTXT *pctxt, const char *filename)
 
void rtxPrintToStreamIndent (OSCTXT *pctxt)
 
void rtxPrintToStreamResetIndent (OSCTXT *pctxt)
 
void rtxPrintToStreamIncrIndent (OSCTXT *pctxt)
 
void rtxPrintToStreamDecrIndent (OSCTXT *pctxt)
 
void rtxPrintToStreamCloseBrace (OSCTXT *pctxt)
 
void rtxPrintToStreamOpenBrace (OSCTXT *pctxt, const char *)
 
void rtxHexDumpToStream (OSCTXT *pctxt, const OSOCTET *data, OSSIZE numocts)
 
void rtxHexDumpToStreamEx (OSCTXT *pctxt, const OSOCTET *data, OSSIZE numocts, OSSIZE bytesPerUnit)
 
void rtxHexDumpToStreamExNoAscii (OSCTXT *pctxt, const OSOCTET *data, OSSIZE numocts, OSSIZE bytesPerUnit)
 

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

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
pctxtA pointer to a context structure.
dataThe pointer to a buffer to be displayed.
numoctsThe number of octets to be displayed

◆ rtxHexDumpToStreamEx()

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
pctxtA pointer to a context structure.
dataThe pointer to a buffer to be displayed.
numoctsThe number of octets to be displayed.
bytesPerUnitThe number of bytes in one unit. May be 1 (byte), 2 (word), or 4 (double word).

◆ rtxHexDumpToStreamExNoAscii()

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
pctxtA pointer to a context structure.
dataThe pointer to a buffer to be displayed.
numoctsThe number of octets to be displayed.
bytesPerUnitThe number of bytes in one unit. May be 1 (byte), 2 (word), or 4 (double word).

◆ rtxPrintToStreamBoolean()

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

Prints a boolean value to a print stream.

Parameters
pctxtA pointer to a context structure.
nameThe name of the variable to print.
valueBoolean value to print.

◆ rtxPrintToStreamCharStr()

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

Prints an ASCII character string value to a print stream.

Parameters
pctxtA pointer to a context structure.
nameThe name of the variable to print.
cstringA pointer to the character string to be printed.

◆ rtxPrintToStreamCloseBrace()

void rtxPrintToStreamCloseBrace ( OSCTXT pctxt)

This function closes a braced region by decreasing the indent level, printing indent spaces, and printing the closing brace.

◆ rtxPrintToStreamDate()

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

Prints a date value to a print stream.

Parameters
pctxtA pointer to a context structure.
nameName of the variable to print.
pvaluePointer to a structure that holds numeric DateTime value to print.

◆ rtxPrintToStreamDateTime()

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

Prints a dateTime value to a print stream.

Parameters
pctxtA pointer to a context structure.
nameName of the variable to print.
pvaluePointer to a structure that holds numeric DateTime value to print.

◆ rtxPrintToStreamDecrIndent()

void rtxPrintToStreamDecrIndent ( OSCTXT pctxt)

This function decrements the current indentation level.

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

◆ rtxPrintToStreamFile()

int rtxPrintToStreamFile ( OSCTXT pctxt,
const char *  filename 
)

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

Parameters
pctxtA pointer to a context structure.
filenameThe name of the text file to print.
Returns
Status of operation, 0 if success.

◆ rtxPrintToStreamHexBinary()

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
pctxtA pointer to a context structure.
nameThe name of the variable to print.
numoctsThe number of octets to be printed.
dataA pointer to the data to be printed.

◆ rtxPrintToStreamHexStr()

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
pctxtA pointer to a context structure.
nameThe name of the variable to print.
numoctsThe number of octets to be printed.
dataA pointer to the data to be printed.

◆ rtxPrintToStreamHexStrNoAscii()

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
pctxtA pointer to a context structure.
nameThe name of the variable to print.
numoctsThe number of octets to be printed.
dataA pointer to the data to be printed.

◆ rtxPrintToStreamHexStrPlain()

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
pctxtA pointer to a context structure.
nameThe name of the variable to print.
numoctsThe number of octets to be printed.
dataA pointer to the data to be printed.

◆ rtxPrintToStreamIncrIndent()

void rtxPrintToStreamIncrIndent ( OSCTXT pctxt)

This function increments the current indentation level.

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

◆ rtxPrintToStreamIndent()

void rtxPrintToStreamIndent ( OSCTXT pctxt)

This function prints indentation spaces to a print stream.

◆ rtxPrintToStreamInt64()

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

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

Parameters
pctxtA pointer to a context structure.
nameThe name of the variable to print.
value64-bit integer value to print.

◆ rtxPrintToStreamInteger()

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

Prints an integer value to a print stream.

Parameters
pctxtA pointer to a context structure.
nameThe name of the variable to print.
valueInteger value to print.

◆ rtxPrintToStreamNull()

void rtxPrintToStreamNull ( OSCTXT pctxt,
const char *  name 
)

Prints a NULL value to a print stream.

Parameters
pctxtA pointer to a context structure.
nameThe name of the variable to print.

◆ rtxPrintToStreamNVP()

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

Prints a name-value pair to a print stream.

Parameters
pctxtA pointer to a context structure.
nameThe name of the variable to print.
valueA pointer to name-value pair structure to print.

◆ rtxPrintToStreamOpenBrace()

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.

◆ rtxPrintToStreamReal()

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

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

Parameters
pctxtA pointer to a context structure.
nameThe name of the variable to print.
valueREAL value to print.

◆ rtxPrintToStreamResetIndent()

void rtxPrintToStreamResetIndent ( OSCTXT pctxt)

This function resets the current indentation level to zero.

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

◆ rtxPrintToStreamTime()

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

Prints a time value to a print stream.

Parameters
pctxtA pointer to a context structure.
nameName of the variable to print.
pvaluePointer to a structure that holds numeric DateTime value to print.

◆ rtxPrintToStreamUInt64()

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

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

Parameters
pctxtA pointer to a context structure.
nameThe name of the variable to print.
valueUnsigned 64-bit integer value to print.

◆ rtxPrintToStreamUnicodeCharStr()

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
pctxtA pointer to a context structure.
nameThe name of the variable to print.
strPointer to unicode sring to be printed. String is an array of C unsigned short data variables.
ncharsNumber of characters in the string. If value is negative, string is assumed to be null-terminated (i.e. ends with a 0x0000 character).

◆ rtxPrintToStreamUnsigned()

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

Prints an unsigned integer value to a print stream.

Parameters
pctxtA pointer to a context structure.
nameThe name of the variable to print.
valueUnsigned integer value to print.

◆ rtxPrintToStreamUTF8CharStr()

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

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

Parameters
pctxtA pointer to a context structure.
nameThe name of the variable to print.
cstringA pointer to the character string to be printed.