Provides script language access to C++ objects of this type.
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| int32 | Acquire | Copies <Str> objects (and transfers ownership if necessary) from the source <StrList> object to this <StrList> object. |
| int32 | Add | Adds a string to this <StrList>. |
| int32 | AddBlank | Adds a blank string to this <StrList>. |
| int32 | AddObj | Adds a <Str> object to the <StrList>. The <StrList> takes ownership of the <Str> object. |
| int32 | AddUnique | Adds a string to the <StrList> if an exact match is not already contained in the <StrList>. |
| int32 | Clear | Clears the <StrList>, deallocates any memory as needed, and resets its count to zero. Does not deallocate the <StrList> object. |
| int32 | Copy | Appends the source <StrList> <Str> objects into this <StrList>. |
| int32 | CopyUnique | Copies all strings from the source to destination that are not already found in the destination. |
| int32 | Fill | Fills the <StrList> with the specified number of items. Existing items will be overwritten, and new items will be created if needed. |
| int32 | Find | Returns the index of the string in the <StrList> or -1 if the string cannot be found. |
| int32 | FindAll | Searches the <StrList> for a string and populates an <Int32Array> with the indices of any matches. |
| int32 | FindNext | Finds the next occurrence of a string in the <StrList>, using the specified index as the start of the search. |
| string | GetAt | Returns the string at the specified index. |
| int32 | GetCount | Returns the number of items in the <StrList>. |
| string | GetFirst | Returns the value of the first string in the <StrList>, if applicable. Otherwise returns an empty string. |
| <Str> | GetFirstObj | Returns a pointer to the first <Str> object in the <StrList>, if applicable. Otherwise returns nullptr. |
| string | GetLast | Returns a <Str> containing the value of the last item in the <StrList>. |
| <Str> | GetLastObj | Returns a pointer to the last <Str> object in the <StrList>, if applicable. Otherwise returns nullptr. |
| string | GetNext | Returns the next string in the <StrList>, using the specified index value as the initial location, or a blank string if the next string does not exist. |
| <Str> | GetObjAt | Returns a pointer to a <Str> object owned by the <StrList>. |
| string | GetPrevious | Returns the previous string in the <StrList>, using the specified index value as the initial location, or a blank string if the previous string does not exist. |
| int32 | In | Returns true if a string is contained in this <StrList>. Otherwise returns false. |
| int32 | Insert | Inserts a string in the <StrList> at the specified index. |
| int32 | InsertAll | Inserts the <Str> objects from the source <StrList> into this <StrList>. |
| int32 | InsertObj | Inserts a <Str> object in the <StrList> at the specified index. The <StrList> takes ownership of the <Str> object. |
| string | LookAhead | Returns a string subsequent to the specified index or a blank string if the queried string does not exist. |
| string | LookBack | Returns a string prior to the specified index or a blank string if the queried string does not exist. |
| int32 | MakeIndex | Populates two Int32Arrays with the indices and counts of all items in the <StrList>. |
| int32 | Nonewhere | Returns true if the string is not in this <StrList>. |
| string | RemoveAt | Removes a string at the specified index. |
| string | RemoveFirst | Removes the first object from the <StrList>. |
| string | RemoveLast | Removes the last string from the <StrList>. |
| int32 | RemoveValue | Removes any strings that match the specified value from this <StrList>. |
| int32 | Replace | Replaces the string at the specified index with the specified string. |
| int32 | Search | Searches the <StrList> for the specified string and returns the index of the first occurrence. |
| int32 | Shrink | Shrinks the <StrList> to a subset of its previous set. |
| int32 | Sort | Sorts the <StrList> in alphabetical order using std::list::sort. |