\section{ost::String Class Reference}
\label{classost_1_1_string}\index{ost::String@{ost::String}}
This is a generic and portable string class.Generic string class.
{\tt \#include $<$string.h$>$}
Inheritance diagram for ost::String::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classost_1_1_string}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item
typedef size\_\-t {\bf size\_\-type}
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf String} ()
\begin{CompactList}\small\item\em Construct an empty string. \item\end{CompactList}\item
{\bf String} (const {\bf String} \&original)
\begin{CompactList}\small\item\em Copy constructor. \item\end{CompactList}\item
{\bf String} (const char $\ast$str)
\begin{CompactList}\small\item\em Create a string from a cstring. \item\end{CompactList}\item
{\bf String} (std::string string)
\begin{CompactList}\small\item\em Create a {\bf String}{\rm (p.\,\pageref{classost_1_1_string})} from std::string. \item\end{CompactList}\item
{\bf String} (const {\bf String} \&str, size\_\-t offset, size\_\-t len={\bf npos})
\begin{CompactList}\small\item\em Create a new string from a subset of another string. \item\end{CompactList}\item
{\bf String} (size\_\-t size, const char $\ast$format,...)
\begin{CompactList}\small\item\em Create a string from formatted text input. \item\end{CompactList}\item
{\bf String} (size\_\-t count, const char fill= ' ')
\begin{CompactList}\small\item\em Fill a new string with character data. \item\end{CompactList}\item
virtual {\bf $\sim$String} ()
\begin{CompactList}\small\item\em Destroy the string. \item\end{CompactList}\item
const char $\ast$ {\bf get\-Index} (size\_\-t index) const
\begin{CompactList}\small\item\em Get a string pointer to string content based on an indexed offset. \item\end{CompactList}\item
char $\ast$ {\bf get\-Text} (void) const
\begin{CompactList}\small\item\em Get the text of a string. \item\end{CompactList}\item
long {\bf get\-Value} (long defvalue=0l) const
\begin{CompactList}\small\item\em Get the value of a string. \item\end{CompactList}\item
bool {\bf get\-Bool} (bool defbool=false) const
\begin{CompactList}\small\item\em Get the bool flag of a string. \item\end{CompactList}\item
const size\_\-t {\bf get\-Length} (void) const
\begin{CompactList}\small\item\em Get the assigned length of string. \item\end{CompactList}\item
const size\_\-t {\bf get\-Size} (void) const
\begin{CompactList}\small\item\em Get the allocation size of the string variable. \item\end{CompactList}\item
bool {\bf is\-Empty} (void) const
\begin{CompactList}\small\item\em Return true if string is empty. \item\end{CompactList}\item
void {\bf resize} (size\_\-t size)
\begin{CompactList}\small\item\em Re-allocate buffer space for string. \item\end{CompactList}\item
void {\bf clear} (void)
\begin{CompactList}\small\item\em Clear the contents of the entire string. \item\end{CompactList}\item
char {\bf at} (ssize\_\-t offset) const
\begin{CompactList}\small\item\em Return a character at a known offset. \item\end{CompactList}\item
unsigned {\bf count} (const {\bf String} \&s, size\_\-t offset=0) const
\begin{CompactList}\small\item\em Count the number of occurences of a specific string within our string. \item\end{CompactList}\item
unsigned {\bf count} (const char $\ast$s, size\_\-t offset=0, size\_\-t len=0) const
\begin{CompactList}\small\item\em Count the number of occurrences of a specific text pattern within our string. \item\end{CompactList}\item
{\bf String} {\bf token} (const char $\ast$delim=\char`\"{} $\backslash$t$\backslash$n$\backslash$r\char`\"{}, size\_\-t offset=0)
\begin{CompactList}\small\item\em Extract a new string as a token from the current string. \item\end{CompactList}\item
size\_\-t {\bf find} (const {\bf String} \&s, size\_\-t offset=0, unsigned instance=1) const
\begin{CompactList}\small\item\em Find the index to the nth instance of a substring in our string. \item\end{CompactList}\item
size\_\-t {\bf rfind} (const {\bf String} \&s, size\_\-t offset=0) const
\begin{CompactList}\small\item\em Find last occurence of a substring in our string. \item\end{CompactList}\item
size\_\-t {\bf find} (const char $\ast$s, size\_\-t offset=0, size\_\-t len=0, unsigned count=1) const
\begin{CompactList}\small\item\em Find the index to the nth instance of text in our string. \item\end{CompactList}\item
size\_\-t {\bf rfind} (const char $\ast$s, size\_\-t offset=0, size\_\-t len=0) const
\begin{CompactList}\small\item\em Find last occurence of a text in our string. \item\end{CompactList}\item
void {\bf trim} (const char $\ast$cs)
\begin{CompactList}\small\item\em Trim trailing characters from a string. \item\end{CompactList}\item
void {\bf chop} (const char $\ast$cs)
\begin{CompactList}\small\item\em Chop leading characters from a string. \item\end{CompactList}\item
void {\bf strip} (const char $\ast$cs)
\begin{CompactList}\small\item\em Strip lead and trailing characters from a string. \item\end{CompactList}\item
void {\bf chop} (size\_\-t chars)
\begin{CompactList}\small\item\em Chop n leading characters from a string. \item\end{CompactList}\item
void {\bf trim} (size\_\-t count)
\begin{CompactList}\small\item\em Trim n trailing characters from a string. \item\end{CompactList}\item
void {\bf erase} (size\_\-t start, size\_\-t len={\bf npos})
\begin{CompactList}\small\item\em Erase a portion of string. \item\end{CompactList}\item
void {\bf insert} (size\_\-t start, const char $\ast$text, size\_\-t len=0)
\begin{CompactList}\small\item\em Insert text into a string. \item\end{CompactList}\item
void {\bf insert} (size\_\-t start, const {\bf String} \&str)
\begin{CompactList}\small\item\em Insert other string into our string. \item\end{CompactList}\item
void {\bf replace} (size\_\-t start, size\_\-t len, const char $\ast$text, size\_\-t count=0)
\begin{CompactList}\small\item\em Replace text at a specific position in the string with new text. \item\end{CompactList}\item
void {\bf replace} (size\_\-t start, size\_\-t len, const {\bf String} \&string)
\begin{CompactList}\small\item\em Replace text at a specific position in the string with new string,. \item\end{CompactList}\item
size\_\-t {\bf find} (unsigned instance, const char $\ast$text, size\_\-t offset=0, size\_\-t len=0) const
\begin{CompactList}\small\item\em A more convenient version of find for nth occurences, by putting the instance first. \item\end{CompactList}\item
size\_\-t {\bf find} (unsigned instance, const {\bf String} \&string, size\_\-t offset=0) const
\begin{CompactList}\small\item\em A more convenient version of find for nth occurences, by putting the instance first. \item\end{CompactList}\item
{\bf String} {\bf substr} (size\_\-t start, size\_\-t len) const
\begin{CompactList}\small\item\em Return a new string that contains a specific substring of the current string. \item\end{CompactList}\item
void {\bf compact} (void)
\begin{CompactList}\small\item\em Reduce the size of the string allocation to the minimum needed based on the current effective length. \item\end{CompactList}\item
char $\ast$ {\bf c\_\-str} (void) const
\begin{CompactList}\small\item\em Old ANSI C++ compatible string pointer extraction. \item\end{CompactList}\item
{\bf operator char $\ast$} () const
\begin{CompactList}\small\item\em Get our string data through dereference operator. \item\end{CompactList}\item
bool {\bf operator!} (void) const
\begin{CompactList}\small\item\em Logical test for string empty. \item\end{CompactList}\item
char $\ast$ {\bf text} (void) const
\begin{CompactList}\small\item\em Alternate get text method. \item\end{CompactList}\item
char $\ast$ {\bf data} (void) const
\begin{CompactList}\small\item\em Alternate get text method. \item\end{CompactList}\item
size\_\-t {\bf length} (void) const
\begin{CompactList}\small\item\em Get length as if null terminated string. \item\end{CompactList}\item
size\_\-t {\bf size} (void) const
\begin{CompactList}\small\item\em Get actual length of string data. \item\end{CompactList}\item
size\_\-t {\bf capacity} (void) const
\begin{CompactList}\small\item\em Get space allocated to hold current string. \item\end{CompactList}\item
bool {\bf empty} (void) const
\begin{CompactList}\small\item\em Return true if string is empty. \item\end{CompactList}\item
void {\bf append} (const char $\ast$str, size\_\-t count=0)
\begin{CompactList}\small\item\em Append text to the end of the current string. \item\end{CompactList}\item
void {\bf append} (size\_\-t size, const char $\ast$format,...)
\begin{CompactList}\small\item\em Append formatted text to the end of the current string. \item\end{CompactList}\item
void {\bf append} (const char $\ast$str, size\_\-t offset, size\_\-t count)
\begin{CompactList}\small\item\em Append text into the current string. \item\end{CompactList}\item
void {\bf add} (char c)
\begin{CompactList}\small\item\em Add a character to the end of a string. \item\end{CompactList}\item
void {\bf append} (const {\bf String} \&str)
\begin{CompactList}\small\item\em Append string to the end of the current string. \item\end{CompactList}\item
const char {\bf operator[$\,$]} (unsigned ind) const
\begin{CompactList}\small\item\em Extract a character by array indexing. \item\end{CompactList}\item
const char $\ast$ {\bf operator=} (const char $\ast$str)
\begin{CompactList}\small\item\em Assign our string for c string. \item\end{CompactList}\item
{\bf String} \& {\bf operator+=} (const {\bf String} \&str)
\begin{CompactList}\small\item\em Append operator. \item\end{CompactList}\item
{\bf String} \& {\bf operator+=} (char c)
\begin{CompactList}\small\item\em Append operator. \item\end{CompactList}\item
{\bf String} \& {\bf operator+=} (const char $\ast$str)
\begin{CompactList}\small\item\em Append operator. \item\end{CompactList}\item
{\bf String} \& {\bf operator+=} (const std::string \&str)
\begin{CompactList}\small\item\em Append operator. \item\end{CompactList}\item
bool {\bf operator$<$} (const {\bf String} \&str) const
\item
bool {\bf operator$<$} (const char $\ast$str) const
\item
bool {\bf operator$>$} (const {\bf String} \&str) const
\item
bool {\bf operator$>$} (const char $\ast$str) const
\item
bool {\bf operator$<$=} (const {\bf String} \&str) const
\item
bool {\bf operator$<$=} (const char $\ast$str) const
\item
bool {\bf operator$>$=} (const {\bf String} \&str) const
\item
bool {\bf operator$>$=} (const char $\ast$str) const
\item
bool {\bf operator==} (const {\bf String} \&str) const
\item
bool {\bf operator==} (const char $\ast$str) const
\item
bool {\bf operator!=} (const {\bf String} \&str) const
\item
bool {\bf operator!=} (const char $\ast$str) const
\item
{\bf String} \& {\bf operator+=} (int i)
\begin{CompactList}\small\item\em Append operator. \item\end{CompactList}\item
{\bf String} \& {\bf operator+=} (unsigned int i)
\item
{\bf String} \& {\bf operator+=} (long l)
\item
{\bf String} \& {\bf operator+=} (unsigned long l)
\item
{\bf String} \& {\bf operator+=} (float f)
\item
{\bf String} \& {\bf operator+=} (double d)
\item
{\bf String} \& {\bf operator+=} (short s)
\item
{\bf String} \& {\bf operator+=} (unsigned short s)
\item
{\bf String} \& {\bf operator=} (int i)
\begin{CompactList}\small\item\em Assignment operator. \item\end{CompactList}\item
{\bf String} \& {\bf operator=} (unsigned int i)
\item
{\bf String} \& {\bf operator=} (long l)
\item
{\bf String} \& {\bf operator=} (unsigned long l)
\item
{\bf String} \& {\bf operator=} (float f)
\item
{\bf String} \& {\bf operator=} (double d)
\item
{\bf String} \& {\bf operator=} (short s)
\item
{\bf String} \& {\bf operator=} (unsigned short s)
\item
{\bf String} \& {\bf operator=} (const {\bf String} \&original)
\item
bool {\bf operator $\ast$=} (const {\bf String} \&str) const
\begin{CompactList}\small\item\em Test if string is contained in our string. \item\end{CompactList}\item
bool {\bf operator $\ast$=} (const char $\ast$str) const
\begin{CompactList}\small\item\em Test if text is contained in our string. \item\end{CompactList}\end{CompactItemize}
\subsection*{Static Public Attributes}
\begin{CompactItemize}
\item
static const size\_\-t {\bf npos}
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item
bool {\bf is\-Big} (void) const
\begin{CompactList}\small\item\em Determine if string is allocated in local variable or an external reference. \item\end{CompactList}\item
const char $\ast$ {\bf set} (const char $\ast$str, size\_\-t len=0)
\begin{CompactList}\small\item\em Set the content of the string variable to the specified string value, and use smart re-allocation strategies if appropriate to shrink the size of the variable. \item\end{CompactList}\item
void {\bf set} (const {\bf String} \&str)
\begin{CompactList}\small\item\em Set the content of the string variable to that of another variable. \item\end{CompactList}\item
const char $\ast$ {\bf set} (size\_\-t size, const char $\ast$format,...)
\begin{CompactList}\small\item\em Set the content of the string variable to that of a formatted printf style string. \item\end{CompactList}\item
void {\bf copy} (const {\bf String} \&str)
\begin{CompactList}\small\item\em Impliment the copy constructor, used internally. \item\end{CompactList}\item
void {\bf init} (void)
\begin{CompactList}\small\item\em Used to initialize a string object. \item\end{CompactList}\item
size\_\-t {\bf set\-Size} (size\_\-t size)
\begin{CompactList}\small\item\em Set the size of allocated space in the string variable (capacity) to a known value. \item\end{CompactList}\item
void {\bf set\-Length} (size\_\-t len)
\begin{CompactList}\small\item\em Set the length value of the string content. \item\end{CompactList}\item
virtual int {\bf compare} (const char $\ast$text, size\_\-t len=0, size\_\-t index=0) const
\begin{CompactList}\small\item\em A derivable low level comparison operator. \item\end{CompactList}\item
size\_\-t {\bf search} (const char $\ast$text, size\_\-t clen=0, size\_\-t offset=0) const
\begin{CompactList}\small\item\em An internal method used to search for a substring starting at a known offset. \item\end{CompactList}\end{CompactItemize}
\subsection*{Static Protected Member Functions}
\begin{CompactItemize}
\item
static char $\ast$ {\bf get\-Space} (size\_\-t size)
\begin{CompactList}\small\item\em Used to fetch memory, if needed, based on the size, from the pager, or the system heap. \item\end{CompactList}\end{CompactItemize}
\subsection*{Static Protected Attributes}
\begin{CompactItemize}
\item
static const unsigned {\bf minsize}
\item
static const unsigned {\bf slotsize}
\item
static const unsigned {\bf pagesize}
\item
static const unsigned {\bf slotlimit}
\item
static const unsigned {\bf slotcount}
\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item
class {\bf String\-Object}
\item
class {\bf Mem\-Pager}
\item
\_\-\_\-EXPORT {\bf String} {\bf operator+} (const {\bf String} \&s1, const {\bf String} \&s2)
\begin{CompactList}\small\item\em Add two strings and return a temporary object. \item\end{CompactList}\item
\_\-\_\-EXPORT {\bf String} {\bf operator+} (const {\bf String} \&s1, const char $\ast$s2)
\item
\_\-\_\-EXPORT {\bf String} {\bf operator+} (const char $\ast$s1, const {\bf String} \&s2)
\item
\_\-\_\-EXPORT {\bf String} {\bf operator+} (const {\bf String} \&s1, const char c2)
\item
\_\-\_\-EXPORT {\bf String} {\bf operator+} (const char c1, const {\bf String} \&s2)
\item
\_\-\_\-EXPORT std::istream \& {\bf getline} (std::istream \&is, {\bf String} \&str, char delim= '$\backslash$n', size\_\-t size=0)
\begin{CompactList}\small\item\em Fetch input from a std::istream into the current string variable until either the string variable is filled (based on current length) or the deliminator is read. \item\end{CompactList}\item
\_\-\_\-EXPORT std::ostream \& {\bf operator$<$$<$} (std::ostream \&os, const {\bf String} \&str)
\begin{CompactList}\small\item\em Stream the content of our string variable directly to a C++ streaming source. \item\end{CompactList}\item
std::istream \& {\bf operator$>$$>$} (std::istream \&is, {\bf String} \&str)
\begin{CompactList}\small\item\em Stream input into our variable. \item\end{CompactList}\item
\_\-\_\-EXPORT int {\bf strprintf} ({\bf String} \&str, size\_\-t size, const char $\ast$format,...)
\begin{CompactList}\small\item\em Print values directly into a string variable. \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
This is a generic and portable string class.Generic string class.
It uses optimized memory allocation strategies to efficiently handle smaller string content by grouping strings into 32 byte aligned slots that can be re-allocated from a free list directly.
While meant to cover the basic functionality of the ANSI C++ string class in form and function, this class offers some important enhancements, including the ability to derive class type specific versions of itself. The latter might be used to derive a unicode string, a string for data and time data types, or to add case insensitive comparisons, for example.
\begin{Desc}
\item[Author:]David Sugar $<${\tt dyfet@ostel.com}$>$ \end{Desc}
\subsection{Member Typedef Documentation}
\index{ost::String@{ost::String}!size_type@{size\_\-type}}
\index{size_type@{size\_\-type}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef size\_\-t {\bf ost::String::size\_\-type}}\label{classost_1_1_string_85905ba5d2314b68a0dabd01bd4e1073}
\subsection{Constructor \& Destructor Documentation}
\index{ost::String@{ost::String}!String@{String}}
\index{String@{String}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::String::String ()}\label{classost_1_1_string_b2d24abe84a18a0bea0c016a03b23164}
Construct an empty string.
\index{ost::String@{ost::String}!String@{String}}
\index{String@{String}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::String::String (const {\bf String} \& {\em original})}\label{classost_1_1_string_66e9e435f30e68647553daca42d9879b}
Copy constructor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em original}]string to copy from. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!String@{String}}
\index{String@{String}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::String::String (const char $\ast$ {\em str})}\label{classost_1_1_string_df107233d4b0186e7555486eaf3a38aa}
Create a string from a cstring.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em str}]text to set with. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!String@{String}}
\index{String@{String}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::String::String (std::string {\em string})}\label{classost_1_1_string_89f5083dbc43475cf9c8d033e5a59833}
Create a {\bf String}{\rm (p.\,\pageref{classost_1_1_string})} from std::string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em string}]from std::string to copy from. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!String@{String}}
\index{String@{String}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::String::String (const {\bf String} \& {\em str}, size\_\-t {\em offset}, size\_\-t {\em len} = {\tt {\bf npos}})}\label{classost_1_1_string_fde617cd82ee3863a38facfbb78a2b8d}
Create a new string from a subset of another string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em str}]reference of source string. \item[{\em offset}]offset to start of data in prior string. \item[{\em len}]length of our substring. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!String@{String}}
\index{String@{String}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::String::String (size\_\-t {\em size}, const char $\ast$ {\em format}, {\em ...})}\label{classost_1_1_string_26235378c5bb25a59bb114e59e557a67}
Create a string from formatted text input.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em size}]to allocate for our new string. \item[{\em format}]of data to input. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!String@{String}}
\index{String@{String}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::String::String (size\_\-t {\em count}, const char {\em fill} = {\tt '~'})}\label{classost_1_1_string_ec3a68ff612b50da26944ddf8697eadf}
Fill a new string with character data.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em count}]size of new string. \item[{\em fill}]char to fill string with. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!~String@{$\sim$String}}
\index{~String@{$\sim$String}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual ost::String::$\sim$String ()\hspace{0.3cm}{\tt [virtual]}}\label{classost_1_1_string_ae61f5e96768dcfe28652d28e7ea5d8d}
Destroy the string.
..
\subsection{Member Function Documentation}
\index{ost::String@{ost::String}!add@{add}}
\index{add@{add}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::add (char {\em c})}\label{classost_1_1_string_739995f39b31348d096dd8b8ee29a91b}
Add a character to the end of a string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em c}]char to add. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!append@{append}}
\index{append@{append}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::append (const {\bf String} \& {\em str})}\label{classost_1_1_string_f8a2a68c43d463d8e18a128a8236bf21}
Append string to the end of the current string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em str}]string to append. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!append@{append}}
\index{append@{append}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::append (const char $\ast$ {\em str}, size\_\-t {\em offset}, size\_\-t {\em count})}\label{classost_1_1_string_c2ec4e3abe270781b8ad6224ef3d9dd9}
Append text into the current string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em str}]text to append. \item[{\em offset}]offset to overlay. \item[{\em count}]size of text to append. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!append@{append}}
\index{append@{append}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::append (size\_\-t {\em size}, const char $\ast$ {\em format}, {\em ...})}\label{classost_1_1_string_535793beca460f5d343e7c3aeb1b8006}
Append formatted text to the end of the current string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em size}]size of text to append. \item[{\em format}]of data to append. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!append@{append}}
\index{append@{append}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::append (const char $\ast$ {\em str}, size\_\-t {\em count} = {\tt 0})}\label{classost_1_1_string_666ed3110afb0670c35e23fabf0c2234}
Append text to the end of the current string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em str}]text to append. \item[{\em count}]size of text to append. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!at@{at}}
\index{at@{at}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char ost::String::at (ssize\_\-t {\em offset}) const}\label{classost_1_1_string_e819ecab95ed17281dd10b491c3b234f}
Return a character at a known offset.
\begin{Desc}
\item[Returns:]character at offset. \end{Desc}
\index{ost::String@{ost::String}!c_str@{c\_\-str}}
\index{c_str@{c\_\-str}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ ost::String::c\_\-str (void) const\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_0a61e7da876bb1b0124df7cf37087613}
Old ANSI C++ compatible string pointer extraction.
\begin{Desc}
\item[Returns:]string data. \end{Desc}
\index{ost::String@{ost::String}!capacity@{capacity}}
\index{capacity@{capacity}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}size\_\-t ost::String::capacity (void) const\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_0b157f7027f9866a316156d510cc554a}
Get space allocated to hold current string.
\begin{Desc}
\item[Returns:]space of memory buffer from heap or local. \end{Desc}
\index{ost::String@{ost::String}!chop@{chop}}
\index{chop@{chop}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::chop (size\_\-t {\em chars})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_f6b5fef41c02aeefb76034f5dc024db4}
Chop n leading characters from a string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em chars}]count to chop. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!chop@{chop}}
\index{chop@{chop}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::chop (const char $\ast$ {\em cs})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_4c83712464157a3d721a2cbd3ee47e66}
Chop leading characters from a string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cs}]list of chars to chop. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!clear@{clear}}
\index{clear@{clear}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::clear (void)}\label{classost_1_1_string_d1b0cf47afac9b11347b49bd5069936a}
Clear the contents of the entire string.
\index{ost::String@{ost::String}!compact@{compact}}
\index{compact@{compact}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::compact (void)\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_b75e0228236c274286254d76c61027d9}
Reduce the size of the string allocation to the minimum needed based on the current effective length.
\index{ost::String@{ost::String}!compare@{compare}}
\index{compare@{compare}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual int ost::String::compare (const char $\ast$ {\em text}, size\_\-t {\em len} = {\tt 0}, size\_\-t {\em index} = {\tt 0}) const\hspace{0.3cm}{\tt [protected, virtual]}}\label{classost_1_1_string_d64c373ca1f9f15535b060a4abf3870c}
A derivable low level comparison operator.
This can be used to create custom comparison data types in derived string classes.
\begin{Desc}
\item[Returns:]0 if match, or value for ordering. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em text}]text to compare. \item[{\em len}]length of text to compare. \item[{\em index}]offset from start of string, used in searchs. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!copy@{copy}}
\index{copy@{copy}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::copy (const {\bf String} \& {\em str})\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_string_508bb8ea0dd1fd2631307cf25d726c7d}
Impliment the copy constructor, used internally.
Will always create a minimum sized string allocation.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em str}]string to copy from. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!count@{count}}
\index{count@{count}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned ost::String::count (const char $\ast$ {\em s}, size\_\-t {\em offset} = {\tt 0}, size\_\-t {\em len} = {\tt 0}) const}\label{classost_1_1_string_b275df353265990190ce3474661201c5}
Count the number of occurrences of a specific text pattern within our string.
\begin{Desc}
\item[Returns:]count of instances. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em s}]text pattern to find \item[{\em offset}]offset to start from. \item[{\em len}]length of text pattern if specified. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!count@{count}}
\index{count@{count}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned ost::String::count (const {\bf String} \& {\em s}, size\_\-t {\em offset} = {\tt 0}) const}\label{classost_1_1_string_22af9a7003fe61e736abc2c7c40bea84}
Count the number of occurences of a specific string within our string.
\begin{Desc}
\item[Returns:]count of instances. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em s}]string to test. \item[{\em offset}]offset to start from. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!data@{data}}
\index{data@{data}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ ost::String::data (void) const\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_55631088f80dde0abe00d9785504e017}
Alternate get text method.
\begin{Desc}
\item[Returns:]string data. \end{Desc}
\index{ost::String@{ost::String}!empty@{empty}}
\index{empty@{empty}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::empty (void) const\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_7aad9abd0339543c09abaa5f7ea60415}
Return true if string is empty.
\index{ost::String@{ost::String}!erase@{erase}}
\index{erase@{erase}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::erase (size\_\-t {\em start}, size\_\-t {\em len} = {\tt {\bf npos}})}\label{classost_1_1_string_42e04bb2da7b775bdf9e9fa90d564d53}
Erase a portion of string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em start}]starting index to erase from. \item[{\em len}]number of characters to erase. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!find@{find}}
\index{find@{find}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}size\_\-t ost::String::find (unsigned {\em instance}, const {\bf String} \& {\em string}, size\_\-t {\em offset} = {\tt 0}) const\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_ba80167902259ca80c8cb092cf1160cf}
A more convenient version of find for nth occurences, by putting the instance first.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em instance}]nth instance to look for. \item[{\em string}]reference to look for. \item[{\em offset}]offset to start at. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!find@{find}}
\index{find@{find}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}size\_\-t ost::String::find (unsigned {\em instance}, const char $\ast$ {\em text}, size\_\-t {\em offset} = {\tt 0}, size\_\-t {\em len} = {\tt 0}) const\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_2ac10dcc3d0fa3368e16c6175cd4ba0b}
A more convenient version of find for nth occurences, by putting the instance first.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em instance}]nth instance to look for. \item[{\em text}]text to look for. \item[{\em offset}]offset to start at. \item[{\em len}]length of text. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!find@{find}}
\index{find@{find}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}size\_\-t ost::String::find (const char $\ast$ {\em s}, size\_\-t {\em offset} = {\tt 0}, size\_\-t {\em len} = {\tt 0}, unsigned {\em count} = {\tt 1}) const}\label{classost_1_1_string_faba551d3d6d841c766bedbc593976c3}
Find the index to the nth instance of text in our string.
\begin{Desc}
\item[Returns:]index of found substring. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em s}]string to search for. \item[{\em offset}]offset to start at. \item[{\em len}]size of string text. \item[{\em count}]instance to look for. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!find@{find}}
\index{find@{find}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}size\_\-t ost::String::find (const {\bf String} \& {\em s}, size\_\-t {\em offset} = {\tt 0}, unsigned {\em instance} = {\tt 1}) const}\label{classost_1_1_string_4115e1252ba5c234101e3b93f699ad8b}
Find the index to the nth instance of a substring in our string.
\begin{Desc}
\item[Returns:]index of found substring. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em s}]string to search for. \item[{\em offset}]offset to start at. \item[{\em instance}]instance to look for. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!getBool@{getBool}}
\index{getBool@{getBool}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::get\-Bool (bool {\em defbool} = {\tt false}) const}\label{classost_1_1_string_212432d62a41fceda8b8b857eab195bd}
Get the bool flag of a string.
\begin{Desc}
\item[Returns:]boolean value. \end{Desc}
\index{ost::String@{ost::String}!getIndex@{getIndex}}
\index{getIndex@{getIndex}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ ost::String::get\-Index (size\_\-t {\em index}) const}\label{classost_1_1_string_87f70220b965c4d800fcd6ac3922c3a0}
Get a string pointer to string content based on an indexed offset.
A NULL is returned if the index is outsize of range.
\begin{Desc}
\item[Returns:]string content or NULL if invalid index. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em index}]\end{description}
\end{Desc}
\index{ost::String@{ost::String}!getLength@{getLength}}
\index{getLength@{getLength}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const size\_\-t ost::String::get\-Length (void) const}\label{classost_1_1_string_0f48ea22625ddf0eccab0c2f7fc50d34}
Get the assigned length of string.
\begin{Desc}
\item[Returns:]string length. \end{Desc}
\index{ost::String@{ost::String}!getSize@{getSize}}
\index{getSize@{getSize}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const size\_\-t ost::String::get\-Size (void) const}\label{classost_1_1_string_8f50cecb57fa70979a1de94ad124bbc4}
Get the allocation size of the string variable.
\begin{Desc}
\item[Returns:]allocation size. \end{Desc}
\index{ost::String@{ost::String}!getSpace@{getSpace}}
\index{getSpace@{getSpace}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}static char$\ast$ ost::String::get\-Space (size\_\-t {\em size})\hspace{0.3cm}{\tt [static, protected]}}\label{classost_1_1_string_013d3632abfe80f72a7a3b9642afcd11}
Used to fetch memory, if needed, based on the size, from the pager, or the system heap.
\begin{Desc}
\item[Returns:]string pointer to space. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em size}]of space needed. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!getText@{getText}}
\index{getText@{getText}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ ost::String::get\-Text (void) const}\label{classost_1_1_string_070f4a92258a62c9f943492e60904a74}
Get the text of a string.
\begin{Desc}
\item[Returns:]string content. \end{Desc}
\index{ost::String@{ost::String}!getValue@{getValue}}
\index{getValue@{getValue}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}long ost::String::get\-Value (long {\em defvalue} = {\tt 0l}) const}\label{classost_1_1_string_892305ab1702f5dc8e669e90057a68b1}
Get the value of a string.
\begin{Desc}
\item[Returns:]string value as number. \end{Desc}
\index{ost::String@{ost::String}!init@{init}}
\index{init@{init}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::init (void)\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_string_ab9a16fccebfd3090852c1c34265ddd4}
Used to initialize a string object.
\index{ost::String@{ost::String}!insert@{insert}}
\index{insert@{insert}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::insert (size\_\-t {\em start}, const {\bf String} \& {\em str})}\label{classost_1_1_string_cc11cf9f05e607721150c3881b8521bc}
Insert other string into our string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em start}]string offset to insert at. \item[{\em str}]string to insert. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!insert@{insert}}
\index{insert@{insert}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::insert (size\_\-t {\em start}, const char $\ast$ {\em text}, size\_\-t {\em len} = {\tt 0})}\label{classost_1_1_string_3bbd6545bf62be1f26224af030fdd43e}
Insert text into a string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em start}]starting offset to insert at. \item[{\em text}]text to insert. \item[{\em len}]size of text to insert. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!isBig@{isBig}}
\index{isBig@{isBig}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::is\-Big (void) const\hspace{0.3cm}{\tt [inline, protected]}}\label{classost_1_1_string_7ac914a48c8fa0b62bd1b2bbcbab198b}
Determine if string is allocated in local variable or an external reference.
\begin{Desc}
\item[Returns:]true if external heap is used. \end{Desc}
\index{ost::String@{ost::String}!isEmpty@{isEmpty}}
\index{isEmpty@{isEmpty}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::is\-Empty (void) const}\label{classost_1_1_string_44e62d49f4243374a9db78ae96422e15}
Return true if string is empty.
\begin{Desc}
\item[Returns:]true if string is empty string. \end{Desc}
\index{ost::String@{ost::String}!length@{length}}
\index{length@{length}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}size\_\-t ost::String::length (void) const\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_6e20e48cec450afc94b4ad79028c665a}
Get length as if null terminated string.
\begin{Desc}
\item[Returns:]cstring length. \end{Desc}
\index{ost::String@{ost::String}!operator *=@{operator $\ast$=}}
\index{operator *=@{operator $\ast$=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::operator $\ast$= (const char $\ast$ {\em str}) const}\label{classost_1_1_string_f118ef6431fb28eee6b0909980cc6f88}
Test if text is contained in our string.
\index{ost::String@{ost::String}!operator *=@{operator $\ast$=}}
\index{operator *=@{operator $\ast$=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::operator $\ast$= (const {\bf String} \& {\em str}) const}\label{classost_1_1_string_5d69eff6b20dd1932530f46cd80f774b}
Test if string is contained in our string.
\index{ost::String@{ost::String}!operator char *@{operator char $\ast$}}
\index{operator char *@{operator char $\ast$}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::String::operator char $\ast$ () const\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_e1d0340be4b75fb4dffa9bfbb392045f}
Get our string data through dereference operator.
\begin{Desc}
\item[Returns:]string data. \end{Desc}
\index{ost::String@{ost::String}!operator"!@{operator"!}}
\index{operator"!@{operator"!}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::operator! (void) const\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_be5bd949279e4c28bfc8da6ba9390cb3}
Logical test for string empty.
\begin{Desc}
\item[Returns:]true if is empty. \end{Desc}
\index{ost::String@{ost::String}!operator"!=@{operator"!=}}
\index{operator"!=@{operator"!=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::operator!= (const char $\ast$ {\em str}) const}\label{classost_1_1_string_8d6e7c31f61848241a45732b7853d9a2}
\index{ost::String@{ost::String}!operator"!=@{operator"!=}}
\index{operator"!=@{operator"!=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::operator!= (const {\bf String} \& {\em str}) const}\label{classost_1_1_string_af1f9e083bcc32bdd8bb216c706b9528}
\index{ost::String@{ost::String}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator+= (unsigned short {\em s})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_da91c5b38a36e81df872b961fa113ebb}
\index{ost::String@{ost::String}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator+= (short {\em s})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_41cbf0206841f041456e488c857a096c}
\index{ost::String@{ost::String}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator+= (double {\em d})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_8c1e14508d84a7d95c2616225a21d33a}
\index{ost::String@{ost::String}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator+= (float {\em f})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_823cc88baabb8e048bb188614a939625}
\index{ost::String@{ost::String}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator+= (unsigned long {\em l})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_5acbad8c51378d0e89dee94e28e661dd}
\index{ost::String@{ost::String}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator+= (long {\em l})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_fadc340cfaa7feb9123ff4651bc01eee}
\index{ost::String@{ost::String}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator+= (unsigned int {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_c918c5417a265af573bb8d762ba32f8f}
\index{ost::String@{ost::String}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator+= (int {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_34654b1a1255922fc6db07fe4905f4a0}
Append operator.
\index{ost::String@{ost::String}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator+= (const std::string \& {\em str})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_0b121a0618f0c382c003ed743a2105a7}
Append operator.
\index{ost::String@{ost::String}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator+= (const char $\ast$ {\em str})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_9a6e240ea4423f2f3a6490e815d38609}
Append operator.
\index{ost::String@{ost::String}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator+= (char {\em c})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_226dfc1df34806f8823307d58ca31809}
Append operator.
\index{ost::String@{ost::String}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator+= (const {\bf String} \& {\em str})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_e35b29db58baee14addc6d55a89eb0ed}
Append operator.
\index{ost::String@{ost::String}!operator<@{operator$<$}}
\index{operator<@{operator$<$}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::operator$<$ (const char $\ast$ {\em str}) const}\label{classost_1_1_string_c048ff521eda5c29a3cca0e65d97d627}
\index{ost::String@{ost::String}!operator<@{operator$<$}}
\index{operator<@{operator$<$}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::operator$<$ (const {\bf String} \& {\em str}) const}\label{classost_1_1_string_0fdb68f36fa980557d29df8a4bcada35}
\index{ost::String@{ost::String}!operator<=@{operator$<$=}}
\index{operator<=@{operator$<$=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::operator$<$= (const char $\ast$ {\em str}) const}\label{classost_1_1_string_8ce1201019c21c834e0b3b7c90596528}
\index{ost::String@{ost::String}!operator<=@{operator$<$=}}
\index{operator<=@{operator$<$=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::operator$<$= (const {\bf String} \& {\em str}) const}\label{classost_1_1_string_e6c50f573f2e345c2f7e466d02390d0c}
\index{ost::String@{ost::String}!operator=@{operator=}}
\index{operator=@{operator=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator= (const {\bf String} \& {\em original})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_4874b2812192bbb51ec0cf89c090ed7f}
\index{ost::String@{ost::String}!operator=@{operator=}}
\index{operator=@{operator=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator= (unsigned short {\em s})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_345c1d34b11e7540109d18fc54748272}
\index{ost::String@{ost::String}!operator=@{operator=}}
\index{operator=@{operator=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator= (short {\em s})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_79d3d45dc3562f54b773c9fec60fd815}
\index{ost::String@{ost::String}!operator=@{operator=}}
\index{operator=@{operator=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator= (double {\em d})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_2d3bae366c4b449d0a348290c6d13600}
\index{ost::String@{ost::String}!operator=@{operator=}}
\index{operator=@{operator=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator= (float {\em f})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_261f66d038787f90e50c53446287e549}
\index{ost::String@{ost::String}!operator=@{operator=}}
\index{operator=@{operator=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator= (unsigned long {\em l})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_0cd98f3bb2b8cb732c23a8c39f78df2d}
\index{ost::String@{ost::String}!operator=@{operator=}}
\index{operator=@{operator=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator= (long {\em l})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_8bfda4c428eac0244cd5500214cc8e7f}
\index{ost::String@{ost::String}!operator=@{operator=}}
\index{operator=@{operator=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator= (unsigned int {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_df7fe167b367fa16acbd0e27204267e1}
\index{ost::String@{ost::String}!operator=@{operator=}}
\index{operator=@{operator=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String}\& ost::String::operator= (int {\em i})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_664dc5f5592f3e8d52f9a68f0c005e58}
Assignment operator.
\index{ost::String@{ost::String}!operator=@{operator=}}
\index{operator=@{operator=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ ost::String::operator= (const char $\ast$ {\em str})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_47e1600ba9bbbafc7d7c5714edb5126c}
Assign our string for c string.
\index{ost::String@{ost::String}!operator==@{operator==}}
\index{operator==@{operator==}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::operator== (const char $\ast$ {\em str}) const}\label{classost_1_1_string_7998519b0e6276ecf0311b8a46ba7b2a}
\index{ost::String@{ost::String}!operator==@{operator==}}
\index{operator==@{operator==}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::operator== (const {\bf String} \& {\em str}) const}\label{classost_1_1_string_f7993fd6298a883a1a21309d5edc4543}
\index{ost::String@{ost::String}!operator>@{operator$>$}}
\index{operator>@{operator$>$}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::operator$>$ (const char $\ast$ {\em str}) const}\label{classost_1_1_string_c88b19841daf8ae9d63045e94a98519c}
\index{ost::String@{ost::String}!operator>@{operator$>$}}
\index{operator>@{operator$>$}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::operator$>$ (const {\bf String} \& {\em str}) const}\label{classost_1_1_string_e63ed602ffcece8de6c86a1d46071bfa}
\index{ost::String@{ost::String}!operator>=@{operator$>$=}}
\index{operator>=@{operator$>$=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::operator$>$= (const char $\ast$ {\em str}) const}\label{classost_1_1_string_dd4456308ae7c9e0821e9b369f3bc01b}
\index{ost::String@{ost::String}!operator>=@{operator$>$=}}
\index{operator>=@{operator$>$=}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::String::operator$>$= (const {\bf String} \& {\em str}) const}\label{classost_1_1_string_03b8c32f9eca6930785a211d03430124}
\index{ost::String@{ost::String}!operator[]@{operator[]}}
\index{operator[]@{operator[]}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char ost::String::operator[$\,$] (unsigned {\em ind}) const\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_20a4d17cdc097955fac3299046fae56a}
Extract a character by array indexing.
\begin{Desc}
\item[Returns:]character code. \end{Desc}
\index{ost::String@{ost::String}!replace@{replace}}
\index{replace@{replace}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::replace (size\_\-t {\em start}, size\_\-t {\em len}, const {\bf String} \& {\em string})}\label{classost_1_1_string_7c55d9183a023be1cf14d30b09e24fd2}
Replace text at a specific position in the string with new string,.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em start}]starting offset to replace at. \item[{\em len}]length of text to remove. \item[{\em string}]reference to replace with. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!replace@{replace}}
\index{replace@{replace}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::replace (size\_\-t {\em start}, size\_\-t {\em len}, const char $\ast$ {\em text}, size\_\-t {\em count} = {\tt 0})}\label{classost_1_1_string_65605c6ac2489d53187d3c92be10efc5}
Replace text at a specific position in the string with new text.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em start}]starting offset to replace at. \item[{\em len}]length of text to remove. \item[{\em text}]text to replace with. \item[{\em count}]size of replacement text. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!resize@{resize}}
\index{resize@{resize}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::resize (size\_\-t {\em size})}\label{classost_1_1_string_06142c1136d37258fd8fda251809dad7}
Re-allocate buffer space for string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em size}]new size to use. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!rfind@{rfind}}
\index{rfind@{rfind}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}size\_\-t ost::String::rfind (const char $\ast$ {\em s}, size\_\-t {\em offset} = {\tt 0}, size\_\-t {\em len} = {\tt 0}) const}\label{classost_1_1_string_b337c1afdba95665189e19686e78a597}
Find last occurence of a text in our string.
\begin{Desc}
\item[Returns:]index of last instance found, \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em s}]string to search for. \item[{\em offset}]offset to start from. \item[{\em len}]size of string to look for. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!rfind@{rfind}}
\index{rfind@{rfind}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}size\_\-t ost::String::rfind (const {\bf String} \& {\em s}, size\_\-t {\em offset} = {\tt 0}) const}\label{classost_1_1_string_547cc3c9e0dbdaf00267199783362f85}
Find last occurence of a substring in our string.
\begin{Desc}
\item[Returns:]index of last instance found, \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em s}]string to search for. \item[{\em offset}]offset to start from. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!search@{search}}
\index{search@{search}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}size\_\-t ost::String::search (const char $\ast$ {\em text}, size\_\-t {\em clen} = {\tt 0}, size\_\-t {\em offset} = {\tt 0}) const\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_string_c74d3616c7aa21e933f15ab1b16d77bf}
An internal method used to search for a substring starting at a known offset.
Used by find and count methods.
\begin{Desc}
\item[Returns:]npos if fails, or offset to text found. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em text}]text to search for. \item[{\em clen}]length of search text. \item[{\em offset}]offset to start from. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!set@{set}}
\index{set@{set}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ ost::String::set (size\_\-t {\em size}, const char $\ast$ {\em format}, {\em ...})\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_string_4940f5282a8c42f576eea0343cd6287d}
Set the content of the string variable to that of a formatted printf style string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em size}]of string data to set. \item[{\em format}]of string to write into object. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!set@{set}}
\index{set@{set}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::set (const {\bf String} \& {\em str})\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_string_3543c215e2d441fe9f59461fb439dfa3}
Set the content of the string variable to that of another variable.
Uses the string set method.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em str}]string to copy from. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!set@{set}}
\index{set@{set}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ ost::String::set (const char $\ast$ {\em str}, size\_\-t {\em len} = {\tt 0})\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_string_0d21f155a16cc4ab41a1bc520a2c7cb6}
Set the content of the string variable to the specified string value, and use smart re-allocation strategies if appropriate to shrink the size of the variable.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em str}]string to set. \item[{\em len}]length of string if passed. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!setLength@{setLength}}
\index{setLength@{setLength}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::set\-Length (size\_\-t {\em len})\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_string_a16b32f848a7e7110b1cf605be45e363}
Set the length value of the string content.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em len}]size in bytes. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!setSize@{setSize}}
\index{setSize@{setSize}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}size\_\-t ost::String::set\-Size (size\_\-t {\em size})\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_string_132784c3db0ab4195205334417d2e030}
Set the size of allocated space in the string variable (capacity) to a known value.
The value is recomputed and adjusted based on allocation method.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em size}]in bytes. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!size@{size}}
\index{size@{size}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}size\_\-t ost::String::size (void) const\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_dce698665ff23d083b7d19994d89cb37}
Get actual length of string data.
\begin{Desc}
\item[Returns:]actual size of string. \end{Desc}
\index{ost::String@{ost::String}!strip@{strip}}
\index{strip@{strip}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::strip (const char $\ast$ {\em cs})}\label{classost_1_1_string_4dadcd30b3fc022d1b4e811e55b4cb61}
Strip lead and trailing characters from a string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cs}]list of chars to strip. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!substr@{substr}}
\index{substr@{substr}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String} ost::String::substr (size\_\-t {\em start}, size\_\-t {\em len}) const\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_da9fae42ef8005c7b1485a3aab875188}
Return a new string that contains a specific substring of the current string.
\begin{Desc}
\item[Returns:]new string. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em start}]starting offset for extracted substring. \item[{\em len}]length of substring. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!text@{text}}
\index{text@{text}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ ost::String::text (void) const\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_685aa757bad592c9bce5488cb58d4518}
Alternate get text method.
\begin{Desc}
\item[Returns:]string data. \end{Desc}
\index{ost::String@{ost::String}!token@{token}}
\index{token@{token}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf String} ost::String::token (const char $\ast$ {\em delim} = {\tt \char`\"{}~$\backslash$t$\backslash$n$\backslash$r\char`\"{}}, size\_\-t {\em offset} = {\tt 0})}\label{classost_1_1_string_772fc79fd3ef70cca499db6fb6c9147e}
Extract a new string as a token from the current string.
\begin{Desc}
\item[Returns:]string containing token. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em delim}]deliminator characters. \item[{\em offset}]offset to start from. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!trim@{trim}}
\index{trim@{trim}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::trim (size\_\-t {\em count})}\label{classost_1_1_string_a7b46c67dc09edc3c1b2005f497cfd40}
Trim n trailing characters from a string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em count}]number of bytes to trim. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!trim@{trim}}
\index{trim@{trim}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::String::trim (const char $\ast$ {\em cs})\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_string_2b2e9b135f4a733cba1c85ce3716b01f}
Trim trailing characters from a string.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cs}]list of chars to trim. \end{description}
\end{Desc}
\subsection{Friends And Related Function Documentation}
\index{ost::String@{ost::String}!getline@{getline}}
\index{getline@{getline}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT std::istream\& getline (std::istream \& {\em is}, {\bf String} \& {\em str}, char {\em delim} = {\tt '$\backslash$n'}, size\_\-t {\em size} = {\tt 0})\hspace{0.3cm}{\tt [friend]}}\label{classost_1_1_string_252e3cf91100c48de755f9094389445c}
Fetch input from a std::istream into the current string variable until either the string variable is filled (based on current length) or the deliminator is read.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em is}]stream to read. \item[{\em str}]string to save into. \item[{\em delim}]deliminator to use. \item[{\em size}]optional size limitor. \end{description}
\end{Desc}
\index{ost::String@{ost::String}!MemPager@{MemPager}}
\index{MemPager@{MemPager}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}friend class {\bf Mem\-Pager}\hspace{0.3cm}{\tt [friend]}}\label{classost_1_1_string_bb6c6f84829d2d5b5dc7e7a696f671d7}
\index{ost::String@{ost::String}!operator+@{operator+}}
\index{operator+@{operator+}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf String} operator+ (const char {\em c1}, const {\bf String} \& {\em s2})\hspace{0.3cm}{\tt [friend]}}\label{classost_1_1_string_c7a5eacf7361351c9e77e9ad13f9efa2}
\index{ost::String@{ost::String}!operator+@{operator+}}
\index{operator+@{operator+}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf String} operator+ (const {\bf String} \& {\em s1}, const char {\em c2})\hspace{0.3cm}{\tt [friend]}}\label{classost_1_1_string_b810edaabd98a773c5d705b6efa0ca80}
\index{ost::String@{ost::String}!operator+@{operator+}}
\index{operator+@{operator+}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf String} operator+ (const char $\ast$ {\em s1}, const {\bf String} \& {\em s2})\hspace{0.3cm}{\tt [friend]}}\label{classost_1_1_string_c842df56491a69bb90e824587163d477}
\index{ost::String@{ost::String}!operator+@{operator+}}
\index{operator+@{operator+}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf String} operator+ (const {\bf String} \& {\em s1}, const char $\ast$ {\em s2})\hspace{0.3cm}{\tt [friend]}}\label{classost_1_1_string_dbd4e2e4d9a23c24868632f0cd973a07}
\index{ost::String@{ost::String}!operator+@{operator+}}
\index{operator+@{operator+}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT {\bf String} operator+ (const {\bf String} \& {\em s1}, const {\bf String} \& {\em s2})\hspace{0.3cm}{\tt [friend]}}\label{classost_1_1_string_1f37546099051712033717576b56de41}
Add two strings and return a temporary object.
\index{ost::String@{ost::String}!operator<<@{operator$<$$<$}}
\index{operator<<@{operator$<$$<$}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT std::ostream\& operator$<$$<$ (std::ostream \& {\em os}, const {\bf String} \& {\em str})\hspace{0.3cm}{\tt [friend]}}\label{classost_1_1_string_cd7a8c0027e32fc49d0fbacf0188070c}
Stream the content of our string variable directly to a C++ streaming source.
\index{ost::String@{ost::String}!operator>>@{operator$>$$>$}}
\index{operator>>@{operator$>$$>$}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::istream\& operator$>$$>$ (std::istream \& {\em is}, {\bf String} \& {\em str})\hspace{0.3cm}{\tt [friend]}}\label{classost_1_1_string_6a83a6539906bef1734f192446a54af6}
Stream input into our variable.
\index{ost::String@{ost::String}!StringObject@{StringObject}}
\index{StringObject@{StringObject}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}friend class {\bf String\-Object}\hspace{0.3cm}{\tt [friend]}}\label{classost_1_1_string_3fff13b89bf24bb3f505990423248985}
\index{ost::String@{ost::String}!strprintf@{strprintf}}
\index{strprintf@{strprintf}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\_\-\_\-EXPORT int strprintf ({\bf String} \& {\em str}, size\_\-t {\em size}, const char $\ast$ {\em format}, {\em ...})\hspace{0.3cm}{\tt [friend]}}\label{classost_1_1_string_21717a0ee76980e5797ca1a9ceb49c4d}
Print values directly into a string variable.
\begin{Desc}
\item[Returns:]character count. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em str}]object reference to use. \item[{\em size}]of string required. \item[{\em format}]of data. \end{description}
\end{Desc}
\subsection{Member Data Documentation}
\index{ost::String@{ost::String}!minsize@{minsize}}
\index{minsize@{minsize}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const unsigned {\bf ost::String::minsize}\hspace{0.3cm}{\tt [static, protected]}}\label{classost_1_1_string_c485909f78a262f94262b886463d3e92}
\index{ost::String@{ost::String}!npos@{npos}}
\index{npos@{npos}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const size\_\-t {\bf ost::String::npos}\hspace{0.3cm}{\tt [static]}}\label{classost_1_1_string_4dac294c1c918721b74efe27cedd3120}
\index{ost::String@{ost::String}!pagesize@{pagesize}}
\index{pagesize@{pagesize}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const unsigned {\bf ost::String::pagesize}\hspace{0.3cm}{\tt [static, protected]}}\label{classost_1_1_string_27b0905a50324ee5e1e575590c72f20d}
\index{ost::String@{ost::String}!slotcount@{slotcount}}
\index{slotcount@{slotcount}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const unsigned {\bf ost::String::slotcount}\hspace{0.3cm}{\tt [static, protected]}}\label{classost_1_1_string_2f38f0b964efdd7b341119555a679949}
\index{ost::String@{ost::String}!slotlimit@{slotlimit}}
\index{slotlimit@{slotlimit}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const unsigned {\bf ost::String::slotlimit}\hspace{0.3cm}{\tt [static, protected]}}\label{classost_1_1_string_a3be0c3844eecaf63aa954d5a874890e}
\index{ost::String@{ost::String}!slotsize@{slotsize}}
\index{slotsize@{slotsize}!ost::String@{ost::String}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const unsigned {\bf ost::String::slotsize}\hspace{0.3cm}{\tt [static, protected]}}\label{classost_1_1_string_a25d9746aa09d5d813f8d66a45c611d6}
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
{\bf string.h}\end{CompactItemize}
