Base Module VST 3.7 SDK for developing VST plug-in

Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
ConstString Class Reference

Invariant String. More...

`#include <fstring.h>`

Inheritance diagram for ConstString:

## Public Types
enum | CompareMode { kCaseSensitive , kCaseInsensitive }

## Public Member Functions
| ConstString (const char8 *str, int32 length=-1)
| Assign from string of type char8 (length=-1: all) More...
| ConstString (const char16 *str, int32 length=-1)
| Assign from string of type char16 (length=-1: all) More...
| ConstString (const ConstString &str, int32 offset=0, int32 length=-1)
| Copy constructor (length=-1: all). More...
| ConstString (const FVariant &var)
| Assign a string from FVariant. More...
| ConstString ()
virtual | ~ConstString ()
| Destructor. More...
virtual int32 | length () const
| Return length of string. More...
bool | isEmpty () const
| Return true if string is empty. More...
| operator const char8 * () const
| Returns pointer to string of type char8 (no modification allowed) More...
| operator const char16 * () const
| Returns pointer to string of type char16(no modification allowed) More...
char | operator[] (short idx) const
| Returns character at 'idx'. More...
char | operator[] (long idx) const
char | operator[] (int idx) const
char | operator[] (unsigned short idx) const
char | operator[] (unsigned long idx) const
char | operator[] (unsigned int idx) const
virtual const char8 * | text8 () const
| Returns pointer to string of type char8. More...
virtual const char16 * | text16 () const
| Returns pointer to string of type char16. More...
virtual const char * | text () const
| Returns pointer to string of type tchar. More...
virtual const void * | ptr () const
| Returns pointer to string of type void. More...
virtual char8 | getChar8 (uint32 index) const
| Returns character of type char16 at 'index'. More...
virtual char16 | getChar16 (uint32 index) const
| Returns character of type char8 at 'index'. More...
char | getChar (uint32 index) const
| Returns character of type tchar at 'index'. More...
char | getCharAt (uint32 index) const
| Returns character of type tchar at 'index', no conversion! More...
bool | testChar8 (uint32 index, char8 c) const
| Returns true if character is equal at position 'index'. More...
bool | testChar16 (uint32 index, char16 c) const
bool | testChar (uint32 index, char8 c) const
bool | testChar (uint32 index, char16 c) const
bool | extract (String &result, uint32 idx, int32 n=-1) const
| Get n characters long substring starting at index (n=-1: until end) More...
int32 | copyTo8 (char8 *str, uint32 idx=0, int32 n=-1) const
int32 | copyTo16 (char16 *str, uint32 idx=0, int32 n=-1) const
int32 | copyTo (char *str, uint32 idx=0, int32 n=-1) const
void | copyTo (IStringResult *result) const
| Copies whole member string. More...
void | copyTo (IString &string) const
| Copies whole member string. More...
uint32 | hash (uint32 tsize) const
int32 | compareAt (uint32 index, const ConstString &str, int32 n=-1, CompareMode m=kCaseSensitive) const
| Compare n characters of str with n characters of this starting at index (return: see above) More...
int32 | compare (const ConstString &str, int32 n, CompareMode m=kCaseSensitive) const
| Compare n characters of str with n characters of this (return: see above) More...
int32 | compare (const ConstString &str, CompareMode m=kCaseSensitive) const
| Compare all characters of str with this (return: see above) More...
int32 | naturalCompare (const ConstString &str, CompareMode mode=kCaseSensitive) const
bool | startsWith (const ConstString &str, CompareMode m=kCaseSensitive) const
| Check if this starts with str. More...
bool | endsWith (const ConstString &str, CompareMode m=kCaseSensitive) const
| Check if this ends with str. More...
bool | contains (const ConstString &str, CompareMode m=kCaseSensitive) const
| Check if this contains str More...
int32 | findLast (const ConstString &str, int32 n=-1, CompareMode m=kCaseSensitive) const
| Find last occurrence of n characters of str in this (n=-1: all) More...
int32 | findLast (char8 c, CompareMode m=kCaseSensitive) const
int32 | findLast (char16 c, CompareMode m=kCaseSensitive) const
int32 | countOccurences (char8 c, uint32 startIndex, CompareMode=kCaseSensitive) const
| Counts occurences of c within this starting at index. More...
int32 | countOccurences (char16 c, uint32 startIndex, CompareMode=kCaseSensitive) const
int32 | getFirstDifferent (const ConstString &str, CompareMode=kCaseSensitive) const
| Returns position of first different character. More...
bool | isDigit (uint32 index) const
| Returns true if character at position is a digit. More...
bool | scanFloat (double &value, uint32 offset=0, bool scanToEnd=true) const
| Converts string to double value starting at offset. More...
bool | scanInt64 (int64 &value, uint32 offset=0, bool scanToEnd=true) const
| Converts string to int64 value starting at offset. More...
bool | scanUInt64 (uint64 &value, uint32 offset=0, bool scanToEnd=true) const
| Converts string to uint64 value starting at offset. More...
bool | scanInt32 (int32 &value, uint32 offset=0, bool scanToEnd=true) const
| Converts string to int32 value starting at offset. More...
bool | scanUInt32 (uint32 &value, uint32 offset=0, bool scanToEnd=true) const
| Converts string to uint32 value starting at offset. More...
bool | scanHex (uint8 &value, uint32 offset=0, bool scanToEnd=true) const
| Converts string to hex/uint8 value starting at offset. More...
int32 | getTrailingNumberIndex (uint32 width=0) const
| Returns start index of trailing number. More...
int64 | getTrailingNumber (int64 fallback=0) const
| Returns result of scanInt64 or the fallback. More...
int64 | getNumber () const
| Returns result of scanInt64. More...
void | toVariant (FVariant &var) const
bool | isWideString () const
| Returns true if string is wide. More...
bool | isAsciiString () const
| Checks if all characters in string are in ascii range. More...
bool | isNormalized (UnicodeNormalization=kUnicodeNormC)
| On PC only kUnicodeNormC is working. More...
Find first occurrence of n characters of str in this (n=-1: all) ending at endIndex (endIndex = -1: all)
int32 | findFirst (const ConstString &str, int32 n=-1, CompareMode m=kCaseSensitive, int32 endIndex=-1) const
int32 | findFirst (char8 c, CompareMode m=kCaseSensitive, int32 endIndex=-1) const
int32 | findFirst (char16 c, CompareMode m=kCaseSensitive, int32 endIndex=-1) const
Find next occurrence of n characters of str starting at startIndex in this (n=-1: all) ending at endIndex (endIndex = -1: all)
int32 | findNext (int32 startIndex, const ConstString &str, int32 n=-1, CompareMode=kCaseSensitive, int32 endIndex=-1) const
int32 | findNext (int32 startIndex, char8 c, CompareMode=kCaseSensitive, int32 endIndex=-1) const
int32 | findNext (int32 startIndex, char16 c, CompareMode=kCaseSensitive, int32 endIndex=-1) const
Find previous occurrence of n characters of str starting at startIndex in this (n=-1: all)
int32 | findPrev (int32 startIndex, const ConstString &str, int32 n=-1, CompareMode=kCaseSensitive) const
int32 | findPrev (int32 startIndex, char8 c, CompareMode=kCaseSensitive) const
int32 | findPrev (int32 startIndex, char16 c, CompareMode=kCaseSensitive) const

## Static Public Member Functions
static bool | isCharSpace (char8 character)
| Returns true if character is a space. More...
static bool | isCharSpace (char16 character)
| Returns true if character is a space. More...
static bool | isCharAlpha (char8 character)
| Returns true if character is an alphabetic character. More...
static bool | isCharAlpha (char16 character)
| Returns true if character is an alphabetic character. More...
static bool | isCharAlphaNum (char8 character)
| Returns true if character is an alphanumeric character. More...
static bool | isCharAlphaNum (char16 character)
| Returns true if character is an alphanumeric character. More...
static bool | isCharDigit (char8 character)
| Returns true if character is a number. More...
static bool | isCharDigit (char16 character)
| Returns true if character is a number. More...
static bool | isCharAscii (char8 character)
| Returns true if character is in ASCII range. More...
static bool | isCharAscii (char16 character)
| Returns true if character is in ASCII range. More...
static bool | isCharUpper (char8 character)
static bool | isCharUpper (char16 character)
static bool | isCharLower (char8 character)
static bool | isCharLower (char16 character)
static bool | scanInt64_8 (const char8 *text, int64 &value, bool scanToEnd=true)
| Converts string of type char8 to int64 value. More...
static bool | scanInt64_16 (const char16 *text, int64 &value, bool scanToEnd=true)
| Converts string of type char16 to int64 value. More...
static bool | scanInt64 (const char *text, int64 &value, bool scanToEnd=true)
| Converts string of type tchar to int64 value. More...
static bool | scanUInt64_8 (const char8 *text, uint64 &value, bool scanToEnd=true)
| Converts string of type char8 to uint64 value. More...
static bool | scanUInt64_16 (const char16 *text, uint64 &value, bool scanToEnd=true)
| Converts string of type char16 to uint64 value. More...
static bool | scanUInt64 (const char *text, uint64 &value, bool scanToEnd=true)
| Converts string of type tchar to uint64 value. More...
static bool | scanInt32_8 (const char8 *text, int32 &value, bool scanToEnd=true)
| Converts string of type char8 to int32 value. More...
static bool | scanInt32_16 (const char16 *text, int32 &value, bool scanToEnd=true)
| Converts string of type char16 to int32 value. More...
static bool | scanInt32 (const char *text, int32 &value, bool scanToEnd=true)
| Converts string of type tchar to int32 value. More...
static bool | scanUInt32_8 (const char8 *text, uint32 &value, bool scanToEnd=true)
| Converts string of type char8 to int32 value. More...
static bool | scanUInt32_16 (const char16 *text, uint32 &value, bool scanToEnd=true)
| Converts string of type char16 to int32 value. More...
static bool | scanUInt32 (const char *text, uint32 &value, bool scanToEnd=true)
| Converts string of type tchar to int32 value. More...
static bool | scanHex_8 (const char8 *text, uint8 &value, bool scanToEnd=true)
| Converts string of type char8 to hex/unit8 value. More...
static bool | scanHex_16 (const char16 *text, uint8 &value, bool scanToEnd=true)
| Converts string of type char16 to hex/unit8 value. More...
static bool | scanHex (const char *text, uint8 &value, bool scanToEnd=true)
| Converts string of type tchar to hex/unit8 value. More...
static char8 | toLower (char8 c)
| Converts to lower case. More...
static char8 | toUpper (char8 c)
| Converts to upper case. More...
static char16 | toLower (char16 c)
static char16 | toUpper (char16 c)
static int32 | multiByteToWideString (char16 *dest, const char8 *source, int32 wcharCount, uint32 sourceCodePage=kCP_Default)
| If dest is zero, this returns the maximum number of bytes needed to convert source. More...
static int32 | wideStringToMultiByte (char8 *dest, const char16 *source, int32 char8Count, uint32 destCodePage=kCP_Default)
| If dest is zero, this returns the maximum number of bytes needed to convert source. More...

## Protected Attributes
union {
void * buffer
char8 * buffer8
char16 * buffer16
}; |
uint32 | len: 30
uint32 | isWide: 1

## Detailed Description

Invariant String.

A base class which provides methods to work with its member string. Neither of the operations allows modifying the member string and that is why all operation are declared as const.

There are operations for access, comparison, find, numbers and conversion.

Almost all operations exist in three versions for char8, char16 and the polymorphic type tchar. The type tchar can either be char8 or char16 depending on whether UNICODE is activated or not.

## Member Enumeration Documentation

## ◆ CompareMode

enum CompareMode

Enumerator
kCaseSensitive | Comparison is done with regard to character's case.
kCaseInsensitive | Comparison is done without regard to character's case.

## Constructor & Destructor Documentation

## ◆ ConstString() [1/5]

ConstString | ( | const char8 * | str,
|  | int32 | length = `-1`
| ) |  |

Assign from string of type char8 (length=-1: all)

## ◆ ConstString() [2/5]

ConstString | ( | const char16 * | str,
|  | int32 | length = `-1`
| ) |  |

Assign from string of type char16 (length=-1: all)

## ◆ ConstString() [3/5]

ConstString | ( | const ConstString & | str,
|  | int32 | offset = `0`,
|  | int32 | length = `-1`
| ) |  |

Copy constructor (length=-1: all).

## ◆ ConstString() [4/5]

ConstString | ( | const FVariant & | var | ) |

Assign a string from FVariant.

## ◆ ConstString() [5/5]

ConstString | ( |  | ) |

## ◆ ~ConstString()

virtual ~ConstString | ( |  | ) |
| inline virtual

Destructor.

## Member Function Documentation

## ◆ length()

virtual int32 length | ( |  | ) | const
| inline virtual

Return length of string.

## ◆ isEmpty()

bool isEmpty | ( |  | ) | const
| inline

Return true if string is empty.

## ◆ operator const char8 *()

operator const char8 * | ( |  | ) | const
| inline

Returns pointer to string of type char8 (no modification allowed)

## ◆ operator const char16 *()

operator const char16 * | ( |  | ) | const
| inline

Returns pointer to string of type char16(no modification allowed)

## ◆ operator[]() [1/6]

char operator[] | ( | short | idx | ) | const
| inline

Returns character at 'idx'.

## ◆ operator[]() [2/6]

char operator[] | ( | long | idx | ) | const
| inline

## ◆ operator[]() [3/6]

char operator[] | ( | int | idx | ) | const
| inline

## ◆ operator[]() [4/6]

char operator[] | ( | unsigned short | idx | ) | const
| inline

## ◆ operator[]() [5/6]

char operator[] | ( | unsigned long | idx | ) | const
| inline

## ◆ operator[]() [6/6]

char operator[] | ( | unsigned int | idx | ) | const
| inline

## ◆ text8()

const char8 * text8 | ( |  | ) | const
| inline virtual

Returns pointer to string of type char8.

Reimplemented in String.

## ◆ text16()

const char16 * text16 | ( |  | ) | const
| inline virtual

Returns pointer to string of type char16.

Reimplemented in String.

## ◆ text()

const char * text | ( |  | ) | const
| inline virtual

Returns pointer to string of type tchar.

## ◆ ptr()

virtual const void * ptr | ( |  | ) | const
| inline virtual

Returns pointer to string of type void.

## ◆ getChar8()

char8 getChar8 | ( | uint32 | index | ) | const
| inline virtual

Returns character of type char16 at 'index'.

Reimplemented in String.

## ◆ getChar16()

char16 getChar16 | ( | uint32 | index | ) | const
| inline virtual

Returns character of type char8 at 'index'.

Reimplemented in String.

## ◆ getChar()

char getChar | ( | uint32 | index | ) | const
| inline

Returns character of type tchar at 'index'.

## ◆ getCharAt()

char getCharAt | ( | uint32 | index | ) | const
| inline

Returns character of type tchar at 'index', no conversion!

## ◆ testChar8()

bool testChar8 | ( | uint32 | index,
|  | char8 | c
| ) |  | const

Returns true if character is equal at position 'index'.

## ◆ testChar16()

bool testChar16 | ( | uint32 | index,
|  | char16 | c
| ) |  | const

## ◆ testChar() [1/2]

bool testChar | ( | uint32 | index,
|  | char8 | c
| ) |  | const
| inline

## ◆ testChar() [2/2]

bool testChar | ( | uint32 | index,
|  | char16 | c
| ) |  | const
| inline

## ◆ extract()

bool extract | ( | String & | result,
|  | uint32 | idx,
|  | int32 | n = `-1`
| ) |  | const

Get n characters long substring starting at index (n=-1: until end)

## ◆ copyTo8()

int32 copyTo8 | ( | char8 * | str,
|  | uint32 | idx = `0`,
|  | int32 | n = `-1`
| ) |  | const

## ◆ copyTo16()

int32 copyTo16 | ( | char16 * | str,
|  | uint32 | idx = `0`,
|  | int32 | n = `-1`
| ) |  | const

## ◆ copyTo() [1/3]

int32 copyTo | ( | char * | str,
|  | uint32 | idx = `0`,
|  | int32 | n = `-1`
| ) |  | const

## ◆ copyTo() [2/3]

void copyTo | ( | IStringResult * | result | ) | const

Copies whole member string.

## ◆ copyTo() [3/3]

void copyTo | ( | IString & | string | ) | const

Copies whole member string.

## ◆ hash()

uint32 hash | ( | uint32 | tsize | ) | const
| inline

## ◆ compareAt()

int32 compareAt | ( | uint32 | index,
|  | const ConstString & | str,
|  | int32 | n = `-1`,
|  | CompareMode | m = `kCaseSensitive`
| ) |  | const

Compare n characters of str with n characters of this starting at index (return: see above)

## ◆ compare() [1/2]

int32 compare | ( | const ConstString & | str,
|  | int32 | n,
|  | CompareMode | m = `kCaseSensitive`
| ) |  | const

Compare n characters of str with n characters of this (return: see above)

## ◆ compare() [2/2]

int32 compare | ( | const ConstString & | str,
|  | CompareMode | m = `kCaseSensitive`
| ) |  | const

Compare all characters of str with this (return: see above)

## ◆ naturalCompare()

Steinberg::int32 naturalCompare | ( | const ConstString & | str,
|  | CompareMode | mode = `kCaseSensitive`
| ) |  | const

## ◆ startsWith()

bool startsWith | ( | const ConstString & | str,
|  | CompareMode | m = `kCaseSensitive`
| ) |  | const

Check if this starts with str.

## ◆ endsWith()

bool endsWith | ( | const ConstString & | str,
|  | CompareMode | m = `kCaseSensitive`
| ) |  | const

Check if this ends with str.

## ◆ contains()

bool contains | ( | const ConstString & | str,
|  | CompareMode | m = `kCaseSensitive`
| ) |  | const

Check if this contains str

## ◆ isCharSpace() [1/2]

bool isCharSpace | ( | char8 | character | ) |
| static

Returns true if character is a space.

## ◆ isCharSpace() [2/2]

bool isCharSpace | ( | char16 | character | ) |
| static

Returns true if character is a space.

## ◆ isCharAlpha() [1/2]

bool isCharAlpha | ( | char8 | character | ) |
| static

Returns true if character is an alphabetic character.

## ◆ isCharAlpha() [2/2]

bool isCharAlpha | ( | char16 | character | ) |
| static

Returns true if character is an alphabetic character.

## ◆ isCharAlphaNum() [1/2]

bool isCharAlphaNum | ( | char8 | character | ) |
| static

Returns true if character is an alphanumeric character.

## ◆ isCharAlphaNum() [2/2]

bool isCharAlphaNum | ( | char16 | character | ) |
| static

Returns true if character is an alphanumeric character.

## ◆ isCharDigit() [1/2]

bool isCharDigit | ( | char8 | character | ) |
| static

Returns true if character is a number.

## ◆ isCharDigit() [2/2]

bool isCharDigit | ( | char16 | character | ) |
| static

Returns true if character is a number.

## ◆ isCharAscii() [1/2]

bool isCharAscii | ( | char8 | character | ) |
| static

Returns true if character is in ASCII range.

## ◆ isCharAscii() [2/2]

bool isCharAscii | ( | char16 | character | ) |
| static

Returns true if character is in ASCII range.

## ◆ isCharUpper() [1/2]

bool isCharUpper | ( | char8 | character | ) |
| static

## ◆ isCharUpper() [2/2]

bool isCharUpper | ( | char16 | character | ) |
| static

## ◆ isCharLower() [1/2]

bool isCharLower | ( | char8 | character | ) |
| static

## ◆ isCharLower() [2/2]

bool isCharLower | ( | char16 | character | ) |
| static

## ◆ findFirst() [1/3]

int32 findFirst | ( | const ConstString & | str,
|  | int32 | n = `-1`,
|  | CompareMode | m = `kCaseSensitive`,
|  | int32 | endIndex = `-1`
| ) |  | const
| inline

## ◆ findFirst() [2/3]

int32 findFirst | ( | char8 | c,
|  | CompareMode | m = `kCaseSensitive`,
|  | int32 | endIndex = `-1`
| ) |  | const
| inline

## ◆ findFirst() [3/3]

int32 findFirst | ( | char16 | c,
|  | CompareMode | m = `kCaseSensitive`,
|  | int32 | endIndex = `-1`
| ) |  | const
| inline

## ◆ findNext() [1/3]

int32 findNext | ( | int32 | startIndex,
|  | const ConstString & | str,
|  | int32 | n = `-1`,
|  | CompareMode | mode = `kCaseSensitive`,
|  | int32 | endIndex = `-1`
| ) |  | const

## ◆ findNext() [2/3]

int32 findNext | ( | int32 | startIndex,
|  | char8 | c,
|  | CompareMode | mode = `kCaseSensitive`,
|  | int32 | endIndex = `-1`
| ) |  | const

## ◆ findNext() [3/3]

int32 findNext | ( | int32 | startIndex,
|  | char16 | c,
|  | CompareMode | mode = `kCaseSensitive`,
|  | int32 | endIndex = `-1`
| ) |  | const

## ◆ findPrev() [1/3]

int32 findPrev | ( | int32 | startIndex,
|  | const ConstString & | str,
|  | int32 | n = `-1`,
|  | CompareMode | mode = `kCaseSensitive`
| ) |  | const

## ◆ findPrev() [2/3]

int32 findPrev | ( | int32 | startIndex,
|  | char8 | c,
|  | CompareMode | mode = `kCaseSensitive`
| ) |  | const

## ◆ findPrev() [3/3]

int32 findPrev | ( | int32 | startIndex,
|  | char16 | c,
|  | CompareMode | mode = `kCaseSensitive`
| ) |  | const

## ◆ findLast() [1/3]

int32 findLast | ( | const ConstString & | str,
|  | int32 | n = `-1`,
|  | CompareMode | m = `kCaseSensitive`
| ) |  | const
| inline

Find last occurrence of n characters of str in this (n=-1: all)

## ◆ findLast() [2/3]

int32 findLast | ( | char8 | c,
|  | CompareMode | m = `kCaseSensitive`
| ) |  | const
| inline

## ◆ findLast() [3/3]

int32 findLast | ( | char16 | c,
|  | CompareMode | m = `kCaseSensitive`
| ) |  | const
| inline

## ◆ countOccurences() [1/2]

int32 countOccurences | ( | char8 | c,
|  | uint32 | startIndex,
|  | CompareMode | mode = `kCaseSensitive`
| ) |  | const

Counts occurences of c within this starting at index.

## ◆ countOccurences() [2/2]

int32 countOccurences | ( | char16 | c,
|  | uint32 | startIndex,
|  | CompareMode | mode = `kCaseSensitive`
| ) |  | const

## ◆ getFirstDifferent()

int32 getFirstDifferent | ( | const ConstString & | str,
|  | CompareMode | mode = `kCaseSensitive`
| ) |  | const

Returns position of first different character.

## ◆ isDigit()

bool isDigit | ( | uint32 | index | ) | const

Returns true if character at position is a digit.

## ◆ scanFloat()

bool scanFloat | ( | double & | value,
|  | uint32 | offset = `0`,
|  | bool | scanToEnd = `true`
| ) |  | const

Converts string to double value starting at offset.

## ◆ scanInt64() [1/2]

bool scanInt64 | ( | int64 & | value,
|  | uint32 | offset = `0`,
|  | bool | scanToEnd = `true`
| ) |  | const

Converts string to int64 value starting at offset.

## ◆ scanUInt64() [1/2]

bool scanUInt64 | ( | uint64 & | value,
|  | uint32 | offset = `0`,
|  | bool | scanToEnd = `true`
| ) |  | const

Converts string to uint64 value starting at offset.

## ◆ scanInt32() [1/2]

bool scanInt32 | ( | int32 & | value,
|  | uint32 | offset = `0`,
|  | bool | scanToEnd = `true`
| ) |  | const

Converts string to int32 value starting at offset.

## ◆ scanUInt32() [1/2]

bool scanUInt32 | ( | uint32 & | value,
|  | uint32 | offset = `0`,
|  | bool | scanToEnd = `true`
| ) |  | const

Converts string to uint32 value starting at offset.

## ◆ scanHex() [1/2]

bool scanHex | ( | uint8 & | value,
|  | uint32 | offset = `0`,
|  | bool | scanToEnd = `true`
| ) |  | const

Converts string to hex/uint8 value starting at offset.

## ◆ getTrailingNumberIndex()

int32 getTrailingNumberIndex | ( | uint32 | width = `0` | ) | const

Returns start index of trailing number.

## ◆ getTrailingNumber()

int64 getTrailingNumber | ( | int64 | fallback = `0` | ) | const

Returns result of scanInt64 or the fallback.

## ◆ getNumber()

int64 getNumber | ( |  | ) | const
| inline

Returns result of scanInt64.

## ◆ scanInt64_8()

bool scanInt64_8 | ( | const char8 * | text,
|  | int64 & | value,
|  | bool | scanToEnd = `true`
| ) |  |
| static

Converts string of type char8 to int64 value.

## ◆ scanInt64_16()

bool scanInt64_16 | ( | const char16 * | text,
|  | int64 & | value,
|  | bool | scanToEnd = `true`
| ) |  |
| static

Converts string of type char16 to int64 value.

## ◆ scanInt64() [2/2]

bool scanInt64 | ( | const char * | text,
|  | int64 & | value,
|  | bool | scanToEnd = `true`
| ) |  |
| static

Converts string of type tchar to int64 value.

## ◆ scanUInt64_8()

bool scanUInt64_8 | ( | const char8 * | text,
|  | uint64 & | value,
|  | bool | scanToEnd = `true`
| ) |  |
| static

Converts string of type char8 to uint64 value.

## ◆ scanUInt64_16()

bool scanUInt64_16 | ( | const char16 * | text,
|  | uint64 & | value,
|  | bool | scanToEnd = `true`
| ) |  |
| static

Converts string of type char16 to uint64 value.

## ◆ scanUInt64() [2/2]

bool scanUInt64 | ( | const char * | text,
|  | uint64 & | value,
|  | bool | scanToEnd = `true`
| ) |  |
| static

Converts string of type tchar to uint64 value.

## ◆ scanInt32_8()

bool scanInt32_8 | ( | const char8 * | text,
|  | int32 & | value,
|  | bool | scanToEnd = `true`
| ) |  |
| inline static

Converts string of type char8 to int32 value.

## ◆ scanInt32_16()

bool scanInt32_16 | ( | const char16 * | text,
|  | int32 & | value,
|  | bool | scanToEnd = `true`
| ) |  |
| inline static

Converts string of type char16 to int32 value.

## ◆ scanInt32() [2/2]

bool scanInt32 | ( | const char * | text,
|  | int32 & | value,
|  | bool | scanToEnd = `true`
| ) |  |
| inline static

Converts string of type tchar to int32 value.

## ◆ scanUInt32_8()

bool scanUInt32_8 | ( | const char8 * | text,
|  | uint32 & | value,
|  | bool | scanToEnd = `true`
| ) |  |
| inline static

Converts string of type char8 to int32 value.

## ◆ scanUInt32_16()

bool scanUInt32_16 | ( | const char16 * | text,
|  | uint32 & | value,
|  | bool | scanToEnd = `true`
| ) |  |
| inline static

Converts string of type char16 to int32 value.

## ◆ scanUInt32() [2/2]

bool scanUInt32 | ( | const char * | text,
|  | uint32 & | value,
|  | bool | scanToEnd = `true`
| ) |  |
| inline static

Converts string of type tchar to int32 value.

## ◆ scanHex_8()

bool scanHex_8 | ( | const char8 * | text,
|  | uint8 & | value,
|  | bool | scanToEnd = `true`
| ) |  |
| static

Converts string of type char8 to hex/unit8 value.

## ◆ scanHex_16()

bool scanHex_16 | ( | const char16 * | text,
|  | uint8 & | value,
|  | bool | scanToEnd = `true`
| ) |  |
| static

Converts string of type char16 to hex/unit8 value.

## ◆ scanHex() [2/2]

bool scanHex | ( | const char * | text,
|  | uint8 & | value,
|  | bool | scanToEnd = `true`
| ) |  |
| static

Converts string of type tchar to hex/unit8 value.

## ◆ toVariant()

void toVariant | ( | FVariant & | var | ) | const

## ◆ toLower() [1/2]

char8 toLower | ( | char8 | c | ) |
| static

Converts to lower case.

## ◆ toUpper() [1/2]

char8 toUpper | ( | char8 | c | ) |
| static

Converts to upper case.

## ◆ toLower() [2/2]

char16 toLower | ( | char16 | c | ) |
| static

## ◆ toUpper() [2/2]

char16 toUpper | ( | char16 | c | ) |
| static

## ◆ multiByteToWideString()

int32 multiByteToWideString | ( | char16 * | dest,
|  | const char8 * | source,
|  | int32 | wcharCount,
|  | uint32 | sourceCodePage = `kCP_Default`
| ) |  |
| static

If dest is zero, this returns the maximum number of bytes needed to convert source.

## ◆ wideStringToMultiByte()

int32 wideStringToMultiByte | ( | char8 * | dest,
|  | const char16 * | source,
|  | int32 | char8Count,
|  | uint32 | destCodePage = `kCP_Default`
| ) |  |
| static

If dest is zero, this returns the maximum number of bytes needed to convert source.

## ◆ isWideString()

bool isWideString | ( |  | ) | const
| inline

Returns true if string is wide.

## ◆ isAsciiString()

bool isAsciiString | ( |  | ) | const

Checks if all characters in string are in ascii range.

## ◆ isNormalized()

bool isNormalized | ( | UnicodeNormalization | n = `kUnicodeNormC` | ) |

On PC only kUnicodeNormC is working.

## Member Data Documentation

## ◆ buffer

void* buffer

## ◆ buffer8

char8* buffer8

## ◆ buffer16

char16* buffer16

## ◆

union { ... } @1

## ◆ len

uint32 len
| protected

## ◆ isWide

uint32 isWide
| protected

Empty

Copyright © Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.