Rogue Wave Views
Data Access Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IliString Class Reference

User interface class. More...

#include <ilviews/dataccess/string.h>

Public Member Functions

 IliString ()
 Initializes an empty string.
 
 IliString (char c)
 Initializes a string of length 1 containing a character. More...
 
 IliString (const char *str)
 Initializes a string initialized with a string. More...
 
 IliString (const char *str, IlUInt len)
 Initializes a string initialized with a string. More...
 
 IliString (const IliString &s)
 This is the copy constructor of class IliString.
 
IliStringappend (const char *str)
 Appends the character string to the string object. More...
 
IliStringappend (const char *str, IlUInt len)
 Appends a substring. More...
 
IliStringappendHex (unsigned long l)
 Appends the character string representation (in hexadecimal) of a long integer to the string. More...
 
IlBoolean isNull () const
 Returns IlTrue if the string is empty. More...
 
IlUInt length () const
 Returns the length of the string in characters. More...
 
void nullify ()
 Sets the length of the string to 0.
 
 operator const char * () const
 Returns the current value of the string as a pointer to an array of constant characters. More...
 
IliStringoperator<< (char c)
 Appends a character. More...
 
IliStringoperator<< (int i)
 Appends an integer. More...
 
IliStringoperator<< (unsigned u)
 Appends the character string representation (in decimal) of an unsigned integer, to the string. More...
 
IliStringoperator<< (long l)
 Appends the character string representation (in decimal) of a long integer, to the string. More...
 
IliStringoperator<< (unsigned long ul)
 Appends the character string representation (in decimal) of an unsigned long integer, to the string. More...
 
IliStringoperator<< (double d)
 Appends the character string representation of the double precision value, to the string. More...
 
IliStringoperator<< (const char *str)
 Appends the character string to the string object. More...
 
IliStringoperator<< (const IliString &str)
 Appends the string to the string object. More...
 
IliStringoperator= (const char *str)
 Sets the value of the IliString object with a string. More...
 
IliStringoperator= (const IliString &str)
 Sets the value of the IliString object with a string. More...
 
const char & operator[] (int i) const
 Returns a constant reference to a character of the string. More...
 
char & operator[] (int i)
 Returns a reference to a character of the string. More...
 
const char & operator[] (long i) const
 Returns a constant reference to a character of the string. More...
 
char & operator[] (long i)
 Returns a reference to a character of the string. More...
 
IliStringprepend (char c)
 Prepends a character to the string. More...
 
IliStringprepend (int i)
 Prepends the character string representation (in decimal) of an integer, to the string. More...
 
IliStringprepend (unsigned u)
 Prepends the character string representation (in decimal) of an unsigned integer, to the string. More...
 
IliStringprepend (long l)
 Prepends the character string representation (in decimal) of a long integer, to the string. More...
 
IliStringprepend (unsigned long ul)
 Prepends the character string representation (in decimal) of an unsigned long integer, to the string. More...
 
IliStringprepend (double d)
 Prepends the character string representation of a double precision value, to the string. More...
 
IliStringprepend (const char *str)
 Prepends the character string to the string object. More...
 
IliStringprepend (const IliString &str)
 Prepends the character string to the string object. More...
 

Detailed Description

User interface class.

Library: dataccess

The IliString class defines objects that manage a character string.

Constructor & Destructor Documentation

IliString::IliString ( char  c)

Initializes a string of length 1 containing a character.

Parameters
cThe character.
IliString::IliString ( const char *  str)

Initializes a string initialized with a string.

Parameters
strThe string.
IliString::IliString ( const char *  str,
IlUInt  len 
)

Initializes a string initialized with a string.

Parameters
strThe string.
lenThe maximum character count to copy.

Member Function Documentation

IliString& IliString::append ( const char *  str)

Appends the character string to the string object.

Parameters
strThe string value.
Returns
The modified object.
IliString& IliString::append ( const char *  str,
IlUInt  len 
)

Appends a substring.

Parameters
strThe string.
lenThe maximum character count to copy.
IliString& IliString::appendHex ( unsigned long  l)

Appends the character string representation (in hexadecimal) of a long integer to the string.

Parameters
lThe long integer value.
IlBoolean IliString::isNull ( ) const

Returns IlTrue if the string is empty.

Returns
IlTrue if the string is empty (that is, if it has a length of 0).
IlUInt IliString::length ( ) const

Returns the length of the string in characters.

Returns
The length of the string in characters. The terminating NULL character is not counted.
IliString::operator const char * ( ) const

Returns the current value of the string as a pointer to an array of constant characters.

Returns
The current value of the string as a pointer to an array of constant characters. The return value is valid only as long as the string object has not been modified or deleted. This cast operator never returns NULL. When the string object is empty, it returns a pointer to a null-terminated character string of length 0.
IliString& IliString::operator<< ( char  c)

Appends a character.

Parameters
cThe character.
Returns
The modified object.
IliString& IliString::operator<< ( int  i)

Appends an integer.

Parameters
iThe integer.
Returns
The modified object.
IliString& IliString::operator<< ( unsigned  u)

Appends the character string representation (in decimal) of an unsigned integer, to the string.

Parameters
uThe unsigned integer.
Returns
The modified object.
IliString& IliString::operator<< ( long  l)

Appends the character string representation (in decimal) of a long integer, to the string.

Parameters
lThe long integer.
Returns
The modified object.
IliString& IliString::operator<< ( unsigned long  ul)

Appends the character string representation (in decimal) of an unsigned long integer, to the string.

Parameters
ulThe unsigned long integer.
Returns
The modified object.
IliString& IliString::operator<< ( double  d)

Appends the character string representation of the double precision value, to the string.

Parameters
dThe double integer.
Returns
The modified object.
IliString& IliString::operator<< ( const char *  str)

Appends the character string to the string object.

Parameters
strThe string value.
Returns
The modified object.
IliString& IliString::operator<< ( const IliString str)

Appends the string to the string object.

Parameters
strThe string value.
Returns
The modified object.
IliString& IliString::operator= ( const char *  str)

Sets the value of the IliString object with a string.

Parameters
strThe string value.
Returns
The modified object.
IliString& IliString::operator= ( const IliString str)

Sets the value of the IliString object with a string.

Parameters
strThe string value.
Returns
The modified object.
const char& IliString::operator[] ( int  i) const

Returns a constant reference to a character of the string.

Parameters
iThe character position.
Returns
A constant reference to the character. If the position is out of bounds, the return value is not meaningful.
char& IliString::operator[] ( int  i)

Returns a reference to a character of the string.

Parameters
iThe character position.
Returns
A reference to the character. If the position is out of bounds, the return value is not meaningful.
const char& IliString::operator[] ( long  i) const

Returns a constant reference to a character of the string.

Parameters
iThe character position.
Returns
A constant reference to the character. If the position is out of bounds, the return value is not meaningful.
char& IliString::operator[] ( long  i)

Returns a reference to a character of the string.

Parameters
iThe character position.
Returns
A reference to the character. If the position is out of bounds, the return value is not meaningful.
IliString& IliString::prepend ( char  c)

Prepends a character to the string.

Parameters
cThe character.
Returns
The modified object.
IliString& IliString::prepend ( int  i)

Prepends the character string representation (in decimal) of an integer, to the string.

Parameters
iThe integer.
Returns
The modified object.
IliString& IliString::prepend ( unsigned  u)

Prepends the character string representation (in decimal) of an unsigned integer, to the string.

Parameters
uThe unsigned integer.
Returns
The modified object.
IliString& IliString::prepend ( long  l)

Prepends the character string representation (in decimal) of a long integer, to the string.

Parameters
lThe long integer.
Returns
The modified object.
IliString& IliString::prepend ( unsigned long  ul)

Prepends the character string representation (in decimal) of an unsigned long integer, to the string.

Parameters
ulThe unsigned long integer.
Returns
The modified object.
IliString& IliString::prepend ( double  d)

Prepends the character string representation of a double precision value, to the string.

Parameters
dThe double.
Returns
The modified object.
IliString& IliString::prepend ( const char *  str)

Prepends the character string to the string object.

Parameters
strThe string.
Returns
The modified object.
IliString& IliString::prepend ( const IliString str)

Prepends the character string to the string object.

Parameters
strThe string.
Returns
The modified object.

© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.