Print values to text buffer functions.
[C Runtime Common Functions]

Functions

int rtPrintToStringBoolean (const char *name, OSBOOL value, char *buffer, OSSIZE bufferSize)
int rtPrintToStringInteger (const char *name, OSINT32 value, char *buffer, OSSIZE bufferSize)
int rtPrintToStringInt64 (const char *name, OSINT64 value, char *buffer, OSSIZE bufferSize)
int rtPrintToStringUnsigned (const char *name, OSUINT32 value, char *buffer, OSSIZE bufferSize)
int rtPrintToStringUInt64 (const char *name, OSUINT64 value, char *buffer, OSSIZE bufferSize)
int rtPrintToStringBitStr (const char *name, OSSIZE numbits, const OSOCTET *data, const char *conn, char *buffer, OSSIZE bufferSize)
int rtPrintToStringBitStrBraceText (const char *name, OSSIZE numbits, const OSOCTET *data, char *buffer, OSSIZE bufferSize)
int rtPrintToStringOctStr (const char *name, OSSIZE numocts, const OSOCTET *data, const char *conn, char *buffer, OSSIZE bufferSize)
int rtPrintToStringCharStr (const char *name, const char *cstring, char *buffer, OSSIZE bufferSize)
int rtPrintToStringUTF8Str (const char *name, const OSUTF8CHAR *ustring, char *buffer, OSSIZE bufferSize)
int rtPrintToString16BitCharStr (const char *name, const Asn116BitCharString *bstring, const char *conn, char *buffer, OSSIZE bufferSize)
int rtPrintToString32BitCharStr (const char *name, const Asn132BitCharString *bstring, const char *conn, char *buffer, OSSIZE bufferSize)
int rtPrintToStringReal (const char *name, OSREAL value, char *buffer, OSSIZE bufferSize)
int rtPrintToStringOID (const char *name, const ASN1OBJID *pOID, char *buffer, OSSIZE bufferSize)
int rtPrintToStringOID64 (const char *name, const ASN1OID64 *pOID, char *buffer, OSSIZE bufferSize)
int rtPrintToStringOIDValue (const ASN1OBJID *pOID, char *buffer, OSSIZE bufferSize)
int rtPrintToStringOID64Value (const ASN1OID64 *pOID, char *buffer, OSSIZE bufferSize)
int rtPrintToStringOpenType (const char *name, OSSIZE numocts, const OSOCTET *data, const char *conn, char *buffer, OSSIZE bufferSize)
int rtPrintToStringOpenTypeExt (const char *name, const OSRTDList *pElemList, char *buffer, OSSIZE bufferSize)
int rtPrintToString (const char *namebuf, char *buffer, OSSIZE bufSize)
int rtPrintToStringHexStr (const char *name, OSSIZE numocts, const OSOCTET *data, char *buffer, OSSIZE bufSize)
int rtPrintToStringUnicodeCharStr (const char *name, const Asn116BitCharString *bstring, char *buffer, OSSIZE bufSize)
int rtPrintToStringUnivCharStr (const char *name, const Asn132BitCharString *bstring, char *buffer, OSSIZE bufSize)
int rtPrintToStringOpenTypeExtBraceText (const char *name, const OSRTDList *pElemList, char *buffer, OSSIZE bufSize)
int rtPrintToStringIndent (char *buffer, OSSIZE bufSize)
void rtPrintToStringIncrIndent (void)
void rtPrintToStringDecrIndent (void)
int rtPrintToStringCloseBrace (char *buffer, OSSIZE bufSize)
int rtPrintToStringOpenBrace (const char *, char *buffer, OSSIZE bufSize)

Detailed Description

Format the output value to string in a "name = value" format. The value format is obtained by calling one of the "ToString" functions with the given value.


Function Documentation

int rtPrintToString ( const char *  namebuf,
char *  buffer,
OSSIZE  bufSize 
)
Parameters:
namebuf A pointer to the buffer name.
buffer Pointer to a buffer to receive the printed value.
bufSize The size of the buffer to receive the printed value.
int rtPrintToString16BitCharStr ( const char *  name,
const Asn116BitCharString bstring,
const char *  conn,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
name The name of the variable to print.
bstring A pointer to a 16-bit string to print.
conn A pointer to the connector between the name and the value. This points to either -> or .
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToString32BitCharStr ( const char *  name,
const Asn132BitCharString bstring,
const char *  conn,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
name The name of the variable to print.
bstring A pointer to a 32-bit string to print.
conn A pointer to the connector between the name and the value. This points to either -> or .
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringBitStr ( const char *  name,
OSSIZE  numbits,
const OSOCTET *  data,
const char *  conn,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
name The name of the variable to print.
numbits The number of bits to be printed.
data A pointer to the data to be printed.
conn A pointer to the connector between the name and the value. This points to either -> or .
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringBitStrBraceText ( const char *  name,
OSSIZE  numbits,
const OSOCTET *  data,
char *  buffer,
OSSIZE  bufferSize 
)

This function prints the value of a bit string to a text buffer in brace text format.

Parameters:
name The name of the variable to print.
numbits The number of bits to be printed.
data A pointer to the data to be printed.
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringBoolean ( const char *  name,
OSBOOL  value,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
name The name of the variable to print.
value ASN.1 value to print (Note: multiple arguments may be used to represent the value- for example a bit string would be represented by a numbits and data argument. See the function prototype forthe exact calling sequence).
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringCharStr ( const char *  name,
const char *  cstring,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
name The name of the variable to print.
cstring A pointer to the character string to be printed.
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringCloseBrace ( char *  buffer,
OSSIZE  bufSize 
)

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

Parameters:
buffer Pointer to a buffer to receive the printed value.
bufSize The size of the buffer to receive the printed value.
void rtPrintToStringDecrIndent ( void   ) 

This function decrements the current indentation level.

int rtPrintToStringHexStr ( const char *  name,
OSSIZE  numocts,
const OSOCTET *  data,
char *  buffer,
OSSIZE  bufSize 
)

This function prints the value of a binary string in hex format to string buffer. 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.
buffer Pointer to a buffer to receive the printed value.
bufSize The size of the buffer to receive the printed value.
void rtPrintToStringIncrIndent ( void   ) 

This function increments the current indentation level.

int rtPrintToStringIndent ( char *  buffer,
OSSIZE  bufSize 
)

This function prints indentation spaces to buffer.

Parameters:
buffer Pointer to a buffer to receive the printed value.
bufSize The size of the buffer to receive the printed value.
int rtPrintToStringInt64 ( const char *  name,
OSINT64  value,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
name The name of the variable to print.
value ASN.1 value to print (Note: multiple arguments may be used to represent the value- for example a bit string would be represented by a numbits and data argument. See the function prototype forthe exact calling sequence).
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringInteger ( const char *  name,
OSINT32  value,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
name The name of the variable to print.
value ASN.1 value to print (Note: multiple arguments may be used to represent the value- for example a bit string would be represented by a numbits and data argument. See the function prototype forthe exact calling sequence).
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringOctStr ( const char *  name,
OSSIZE  numocts,
const OSOCTET *  data,
const char *  conn,
char *  buffer,
OSSIZE  bufferSize 
)
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.
conn A pointer to the connector between the name and the value. This points to either -> or .
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringOID ( const char *  name,
const ASN1OBJID pOID,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
name The name of the variable to print.
pOID A pointer to a OID to be printed.
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringOID64 ( const char *  name,
const ASN1OID64 pOID,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
name The name of the variable to print.
pOID A pointer to a OID to be printed.
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringOID64Value ( const ASN1OID64 pOID,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
bufferIndex The index to the buffer.
pOID A pointer to a OID to be printed.
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringOIDValue ( const ASN1OBJID pOID,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
bufferIndex The index to the buffer.
pOID A pointer to a OID to be printed.
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringOpenBrace ( const char *  ,
char *  buffer,
OSSIZE  bufSize 
)

This function opens a braced region by printing indent spaces, printing the name and opening brace, and increasing the indent level.

Parameters:
buffer Pointer to a buffer to receive the printed value.
bufSize The size of the buffer to receive the printed value.
int rtPrintToStringOpenType ( const char *  name,
OSSIZE  numocts,
const OSOCTET *  data,
const char *  conn,
char *  buffer,
OSSIZE  bufferSize 
)
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.
conn A pointer to the connector between the name and the value. This points to either -> or .
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringOpenTypeExt ( const char *  name,
const OSRTDList pElemList,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
name The name of the variable to print.
pElemList A pointer to the element to be printed.
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringOpenTypeExtBraceText ( const char *  name,
const OSRTDList pElemList,
char *  buffer,
OSSIZE  bufSize 
)

This function prints the value of an open type extension in brace text format to buffer.

Parameters:
name The name of the variable to print.
pElemList A pointer to an element of a list.
buffer Pointer to a buffer to receive the printed value.
bufSize The size of the buffer to receive the printed value.
int rtPrintToStringReal ( const char *  name,
OSREAL  value,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
name The name of the variable to print.
value ASN.1 value to print (Note: multiple arguments may be used to represent the value- for example a bit string would be represented by a numbits and data argument. See the function prototype forthe exact calling sequence).
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringUInt64 ( const char *  name,
OSUINT64  value,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
name The name of the variable to print.
value ASN.1 value to print (Note: multiple arguments may be used to represent the value- for example a bit string would be represented by a numbits and data argument. See the function prototype for the exact calling sequence).
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringUnicodeCharStr ( const char *  name,
const Asn116BitCharString bstring,
char *  buffer,
OSSIZE  bufSize 
)

This function prints a Unicode string to string buffer. 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.
bstring A pointer to the bit string to be printed.
buffer Pointer to a buffer to receive the printed value.
bufSize The size of the buffer to receive the printed value.
int rtPrintToStringUnivCharStr ( const char *  name,
const Asn132BitCharString bstring,
char *  buffer,
OSSIZE  bufSize 
)

This function prints a Universal string to string buffer. Characters in the string that are within the normal Ascii range are printed as single characters. Characters outside the Ascii range are printed as 8-byte hex codes (0xnnnnnnnn).

Parameters:
name The name of the variable to print.
bstring A pointer to the bit string to be printed.
buffer Pointer to a buffer to receive the printed value.
bufSize The size of the buffer to receive the printed value.
int rtPrintToStringUnsigned ( const char *  name,
OSUINT32  value,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
name The name of the variable to print.
value ASN.1 value to print (Note: multiple arguments may be used to represent the value- for example a bit string would be represented by a numbits and data argument. See the function prototype for the exact calling sequence).
bufferSize The size of the buffer to receive the printed value.
buffer Pointer to a buffer to receive the printed value.
int rtPrintToStringUTF8Str ( const char *  name,
const OSUTF8CHAR *  ustring,
char *  buffer,
OSSIZE  bufferSize 
)
Parameters:
name The name of the variable to print.
ustring A pointer to the UTF-8 string to be printed.
bufferSize The size of the buffer to receive the printed value.
buffer A pointer to a buffer to receive the printed value.