Value :: removeString - Remove string from text field

The function removes a sub string from a text data value.

When no instance is selected in the value handle or the value is not a text property, the function throws an exception.

Return value: Success ( bool )

The value is true when the function was executed successfully. Otherwise the value is set to false .

Implementation overview

Remove data between strings
Value :: removeString ( sStart, sStop )
Remove data between strings inclusive search strings
Value :: removeString ( sStart, sStop, bInclusive )
Remove substring
Value :: removeString ( iPosition, iLength )

Implementation details

Remove data between strings
bool Value :: removeString ( odaba::String &sStart, odaba::String &sStop )

The function removes data between the strings passed in sStart and sStop . Only the text between search strings will be removed.

When passing an empty string in sStart , text will be removed from the beginning. When passing an empty string in sStop , text will be removed from start string until end of text.
- sStart - - internal feature (not documented)
- sStop - - Title unknown

Remove data between strings inclusive search strings
bool Value :: removeString ( odaba::String &sStart, odaba::String &sStop, bool bInclusive )

The function removes data between the strings passed in sStart and sStop . When passing true in bInclusive , search strings are removed, too. Otherwise only the text between search strings will be removed.

When passing an empty string in sStart , text will be removed from the beginning. When passing an empty string in sStop , text will be removed from start string until end of text.
- sStart - - internal feature (not documented)
- sStop - - Title unknown
- bInclusive - Include begin and end string

Remove substring
bool Value :: removeString ( int32 iPosition, int32 iLength )
The function removes the string at position iPosition with the length iLength from the text value. When the position is less than 0 or greater than the value text size, the function throws an exception.
- iPosition - Position in collection
  The position of an element in a collection is beginning with 0 for the first element.
- iLength - Length
  The length is the size allocated for an instance or area.