# String

## Functions

| `String`
| `String`
| `String`
| `String`
| `String`
| `String`
| `~String`
void | `Set`
String const & | `operator=`
char const * | `CStr`
wchar_t const * | `WStr`
size_t | `WLength`
bool | `Equals`
bool | `operator==`
bool | `operator!=`

## Detailed Description

class String

  This class is used to specify any string which may be associated with an Entity or ViewEntity. It takes standard character and wide character strings as well as making use of the H_UTF and H_WCS utility classes to allow specifying stings with the various UTF encodings.

  Public Functions

  String()
  String(char const *cstring)
  String(wchar_t const *wstring)
  String(H_WCS const &wcs)
  String(H_UTF8 const &utf8)
  String(String const &that)
  ~String()
  void Set(String const &in_that)
  String const &operator=(String const &in_that)
  char const *CStr() const
    Returns

      the standard C-string representation of the String

  wchar_t const *WStr() const
    Returns

      the wide character representation of the String

  size_t WLength() const
    Returns

      the number of characters in the String

  bool Equals(String const &in_that) const
  bool operator==(String const &in_that) const
  bool operator!=(String const &in_that) const