SbString(3IV)

NAME
     SbString (SbStr) - class for smart character strings

INHERITS FROM
     SbString

SYNOPSIS
     #include <Inventor_c/SbString.h>

     typedef SbString    SbStr

          Functions from class SbString:

     SbString *          SbStrCreate()
     SbString *          SbStrCreateStr(const char *str)
     SbString *          SbStrCreateSubStr(const char *str, int start, int
                              end)
     SbString *          SbStrCreateCopy(const SbString *str)
     SbString *          SbStrCreateInt(int digitString)
     void                SbStrDelete(SbStr *this)
     uint32_t            SbStrHash(SbStr *this)
     int                 SbStrGetLen(const SbStr *this)
     void                SbStrEmpty(SbStr *this, SbBool freeOld = TRUE)
     const char *        SbStrGetStr(const SbStr *this)
     SbString            SbStrGetSubStr(const SbStr *this, int startChar, int
                              endChar = -1)
     void                SbStrDeleteSubStr(SbStr *this, int startChar, int
                              endChar = -1)
     SbString *          SbStrCopyStr(SbStr *this, const char *str)
     SbString *          SbStrCopy(SbStr *this, const SbString *str)
     SbString *          SbStrConcatStr(SbStr *this, const char *str)
     SbString *          SbStrConcat(SbStr *this, const SbString *str)
     int                 SbStrNot(const SbStr *this)
     int                 SbStrIsEqStr(SbStr *this, const SbString *str, const
                              char *s)
     int                 SbStrIsEq(SbStr *this, const SbString *str1, const
                              SbString *str2)
     int                 SbStrIsNEqStr(SbStr *this, const SbString *str, const
                              char *s)
     int                 SbStrIsNEq(SbStr *this, const SbString *str1, const
                              SbString *str2)


DESCRIPTION
     Strings which have many convenience methods to make string manipulation
     easier.

FUNCTIONS
     SbString *          SbStrCreate()
     SbString *          SbStrCreateStr(const char *str)
     SbString *          SbStrCreateSubStr(const char *str, int start, int
                              end)
     SbString *          SbStrCreateCopy(const SbString *str)
     SbString *          SbStrCreateInt(int digitString)
     void                SbStrDelete(SbStr *this)
          Constructors and destructor. Constructors take a character string,
          the subset of a character string from start to end (inclusive), or
          an integer to be turned into a string.

     uint32_t            SbStrHash(SbStr *this)
          Returns a reasonable hash key for string.

     int                 SbStrGetLen(const SbStr *this)
          Returns length of string.

     void                SbStrEmpty(SbStr *this, SbBool freeOld = TRUE)
          Sets string to be the empty string (""). If freeOld is TRUE
          (default), any old storage is freed up.

     const char *        SbStrGetStr(const SbStr *this)
          Returns pointer to the character string.

     SbString            SbStrGetSubStr(const SbStr *this, int startChar, int
                              endChar = -1)
          Returns new string representing sub-string from startChar to
          endChar, inclusive. If endChar is -1 (the default), the sub-string
          from startChar until the end is returned.

     void                SbStrDeleteSubStr(SbStr *this, int startChar, int
                              endChar = -1)
          Deletes the characters from startChar to endChar, inclusive, from
          the string. If endChar is -1 (the default), all characters from
          startChar until the end are deleted.

     SbString *          SbStrCopyStr(SbStr *this, const char *str)
     SbString *          SbStrCopy(SbStr *this, const SbString *str)
          Assignment operators for character string, SbString.

     SbString *          SbStrConcatStr(SbStr *this, const char *str)
     SbString *          SbStrConcat(SbStr *this, const SbString *str)
          Concatenation operators "+=" for string, SbString.

     int                 SbStrNot(const SbStr *this)
          Unary "not" operator; returns TRUE if string is empty ("").

     int                 SbStrIsEqStr(SbStr *this, const SbString *str, const
                              char *s)
     int                 SbStrIsEq(SbStr *this, const SbString *str1, const
                              SbString *str2)
          Equality operator for SbString/char* and SbString/SbString
          comparison.

     int                 SbStrIsNEqStr(SbStr *this, const SbString *str, const
                              char *s)
     int                 SbStrIsNEq(SbStr *this, const SbString *str1, const
                              SbString *str2)
          Inequality operator for SbString/char* and SbString/SbString
          comparison.


FILE FORMAT/DEFAULTS
     String {
     }

SEE ALSO
     SbName