Provides script language access to C++ objects of this type.
| Class Hierarchy | No registered superclass. |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| <StrArray> | StrArray | This constructor. |
| int32 | Add | Adds a string to the array. Note that this does not add a <Str> object. See also AddObj. |
| int32 | AddAscendingIfUnique | This option is undocumented at present. |
| int32 | AddBlank | Adds a blank entry to the array. |
| int32 | AddDescendingIfUnique | This option is undocumented at present. |
| int32 | AddIfUnique | Adds a string to the array if it is not already present. This is test by value, not by pointer. For example: adds 'myString' if it is not present. |
| int32 | AddObj | Adds a <Str> object to the array. |
| <Str> | AsStr | Fills a <Str> object with the contents of all the <Str> objects in the array. |
| int32 | BindIterators | Binds iterators to this object. |
| int32 | Clear | Clears this array and deallocates any memory. Does not destroy the array object. |
| int32 | Copy | Copies the source array into this array. The contents of this array are replaced. |
| int32 | Del | Deletes the array element at the specified index. This causes the array to undergo the allocation/copy cycle. |
| int32 | ElementSize | Returns the size in bytes of <Str> |
| int32 | Fill | Fills the the array with a string value. Note that this does not use a <Str> object. |
| int32 | Find | Returns the index of the specified value, or -1 if it is not in the array. |
| int32 | FindAny | Returns true if any of the values in another <StrArray> are also in this array. |
| int32 | FindObj | Returns the index of the specified value, or -1 if it is not in the array. |
| <StrArrayIterator> | First | Returns a pointer to an iterator to the start of the array. |
| string | Get | Returns the string value at the specified index. |
| int32 | GetCount | Returns the count of the array. |
| string | GetFirst | Returns the first value in the array. |
| string | GetLast | Returns the last value in the array. |
| <Str> | GetObj | Returns a pointer to the <Str> object at the specified inde. |
| <StrArrayView> | GetView | Returns a pointer to a <StrArrayView> object that has iterators to the start and end of the collection. |
| int32 | In | Returns true if the specified value is in the array. |
| int32 | Insert | Inserts the specified value at the specified index. This causes an allocation/copy cycle. |
| int32 | InsertAscending | Insertion sorts values added to this array. |
| int32 | InsertDescending | Insertion sorts values added to this array. |
| int32 | IsEmpty | Returns true if the array has a count of zero. |
| <StrArrayIterator> | Last | Returns a pointer to an iterator to the end of the array. |
| int32 | Move | Moves this array into the destinary array. This array is left empty, with a count of zero, but the array object itself is not destroyed. |
| int32 | Pop | Pops the first item off the top of the stack. |
| int32 | Push | Pushes an item onto the stack ( at the end ). |
| int32 | Relocate | Relocates a chunk of the array to a new index. |
| int32 | RemoveFirst | Removes the first item from the array. |
| int32 | RemoveLast | Removes the last item from the array. |
| int32 | Set | Sets the value at the specified inde |
| int32 | SetCount | Sets the count of the array. |
| int32 | SetObj | Sets the value at the specified index. |
| int32 | SizeInBytes | Returns the size in bytes of the array, which is the total number of bytes currently being used by the array, and does not include any allocated reserve. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| Str[] | Objects[ index ] | Gets or sets the value of an element in the array at the specified index. The syntax is array.Objects[ n ], where n is a valid index into the array. |
| <StrArray> | Value | Returns the value of this object's underlying array. For example: to assign the value of this object to another array using array_a.Value = array_b.Value. |
| int32 | Count | Sets or gets the array count. |
| int32 | Reserve | Gets or sets the reserve allocation. Note: this does not change the array count, it merely changes the size of the underlying buffer. |