Array functions
Append
Declaration
void Append(VariantList list, Variant variant)Description
Appends a variant to the end of a list.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
list
|
The list to append to.
|
variant
|
The variant to append.
|
Return Value
Does not return a value.
Append
Declaration
void Append(JsonArray array, string value)Description
Append value to given JsonArray.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
array
|
JsonArray instance to which to add a value.
|
value
|
Value to add.
|
Return Value
Does not return a value.
Append
Declaration
void Append(JsonArray array, bool value)Description
Append value to given JsonArray.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
array
|
JsonArray instance to which to add a value.
|
value
|
Value to add.
|
Return Value
Does not return a value.
Append
Declaration
void Append(JsonArray array, int value)Description
Append value to given JsonArray.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
array
|
JsonArray instance to which to add a value.
|
value
|
Value to add.
|
Return Value
Does not return a value.
Append
Declaration
void Append(JsonArray array, double value)Description
Append value to given JsonArray.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
array
|
JsonArray instance to which to add a value.
|
value
|
Value to add.
|
Return Value
Does not return a value.
Append
Declaration
void Append(JsonArray array, DateTime value)Description
Append value to given JsonArray.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
array
|
JsonArray instance to which to add a value.
|
value
|
Value to add.
|
Return Value
Does not return a value.
Append
Declaration
void Append(JsonArray array, JsonDictionary value)Description
Append value to given JsonArray.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
array
|
JsonArray instance to which to add a value.
|
value
|
Value to add.
|
Return Value
Does not return a value.
Append
Declaration
void Append(JsonArray array, JsonArray value)Description
Append value to given JsonArray.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
array
|
JsonArray instance to which to add a value.
|
value
|
Value to add.
|
Return Value
Does not return a value.
Append
Declaration
void Append(StringArray array, string element)Description
Appends a string to the end of the array.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The array to append to.
|
element
|
The element to append.
|
Return Value
Does not return a value.
Append
Declaration
void Append(IntArray array, int element)Description
Appends an int to the end of an array.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The array to append to.
|
element
|
The element to append.
|
Return Value
Does not return a value.
Append
Declaration
void Append(DoubleArray array, double element)Description
Appends a double to the end of an array.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The array to append to.
|
element
|
The element to append.
|
Return Value
Does not return a value.
Append
Declaration
void Append(StringList list, string element)Description
Appends a string to the end of the StringList.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
list
|
The list to append to.
|
element
|
The element to append.
|
Return Value
Does not return a value.
Append
Declaration
void Append(StringList list, DataAreaDimensionFilter element)Description
Appends a DataAreaDimensionFilter element to the end of the StringList.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
list
|
The list to append to.
|
element
|
The element to append.
|
Return Value
Does not return a value.
Append
Declaration
void Append(StringListList list, StringList element)Description
Appends a StringList to the end of the StringListList.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
list
|
The list to append to.
|
element
|
The element to append.
|
Return Value
Does not return a value.
AppendDistinct
Declaration
void AppendDistinct(StringList list, string element)Description
Appends a string to the StringList, if the list does not already contain it.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
list
|
The list to append to.
|
element
|
The element to append.
|
Return Value
Does not return a value.
AppendDistinct
Declaration
void AppendDistinct(StringArray array, string element)Description
Appends a string to the array, if the array does not already contain it.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The array to append to.
|
element
|
The element to append.
|
Return Value
Does not return a value.
AppendDistinct
Declaration
void AppendDistinct(IntArray array, int element)Description
Appends an int to an array, if the array does not already contain it.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The array to append to.
|
element
|
The element to append.
|
Return Value
Does not return a value.
AppendDistinct
Declaration
void AppendDistinct(DoubleArray array, double element)Description
Appends a double to an array, if the array does not already contain it.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The array to append to.
|
element
|
The element to append.
|
Return Value
Does not return a value.
Clear
Declaration
void Clear(StringList list)Description
Clears a StringList object.
Supported Runtime Versions
4.0, 5.0
Parameters
|
Description
|
|---|---|
list
|
A StringList to clear.
|
Return Value
Does not return a value.
Concat
Declaration
StringList Concat(StringList s1, StringList s2)Description
Concatenates two StringList objects.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
s1
|
First StringList to be concatenated.
|
s2
|
Second StringList to be concatenated.
|
Return Value
A new StringList consisting of s1 and s2.
Contains
Declaration
bool Contains(StringList list, string element)Description
Checks whether a StringList contains a certain element.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
list
|
The StringList to be checked.
|
element
|
The element to look for.
|
Return Value
True, if the list contains element, false otherwise.
Contains
Declaration
bool Contains(StringArray array, string element)Description
Checks whether a StringArray contains a certain element.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The StringArray to be checked.
|
element
|
The element to look for.
|
Return Value
True, if the array contains element, false otherwise.
Contains
Declaration
bool Contains(DoubleArray array, double element)Description
Checks whether a DoubleArray contains a certain element.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The DoubleArray to be checked.
|
element
|
The element to look for.
|
Return Value
True, if the array contains element, false otherwise.
Contains
Declaration
bool Contains(IntArray array, int element)Description
Checks whether an IntArray contains a certain element.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The IntArray to be checked.
|
element
|
The element to look for.
|
Return Value
True, if the array contains element, false otherwise.
ConvertToStringArray
Declaration
StringArray ConvertToStringArray(StringList list)Description
Converts a StringList into a StringArray.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
list
|
The StringList to be converted.
|
Return Value
A new StringArray containing the same elements as list.
Count
Declaration
int Count(VariantList list)Description
Returns the number of elements in a list.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
list
|
The list to calculate the number of elements for.
|
Return Value
The number of elements in a 'list'.
Count
Declaration
int Count(CompanyJournalLineList list)Description
Returns the number of elements in a collection.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
list
|
The list that contains company journal lines.
|
Return Value
The number of elements in a collection.
Count
Declaration
int Count(GroupJournalLineList list)Description
Returns the number of elements in a collection.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
list
|
The list that contains group journal lines.
|
Return Value
The number of elements in a collection.
Count
Declaration
int Count(VariantDictionary dictionary)Description
Returns the number of key/value pairs stored in the dictionary.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
dictionary
|
Dictionary to count number of key/value pairs for.
|
Return Value
The number of key/value pairs stored in the dictionary.
Count
Declaration
int Count(JsonDictionary dictionary)Description
Returns number of properties in the given dictionary.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
dictionary
|
JsonDictionary instance.
|
Return Value
The number of properties in the given dictionary.
Count
Declaration
int Count(JsonArray array)Description
Returns number of items in given JsonArray.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
array
|
JsonArray instance.
|
Return Value
Length of the array.
Count
Declaration
int Count(XMLElementList elements)Description
Returns the number of elements in an XMLElementList.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
elements
|
The list to count the elements of.
|
Return Value
The number of elements in the list.
Count
Declaration
int Count(XMLAttributeList attributes)Description
Returns the number of attributes in an XMLAttributeList.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
attributes
|
The list to count the attributes of.
|
Return Value
The number of attributes in the list.
Count
Declaration
int Count(StringArray array)Description
Returns the number of elements in an array.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The array to calculate the number of elements for.
|
Return Value
The number of elements in an 'array'.
Count
Declaration
int Count(StringListList list)Description
Returns the number of elements in a StringListList.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
list
|
The list to calculate the number of elements for.
|
Return Value
The number of elements in a 'list'.
Count
Declaration
int Count(OLAPElementNativeArray array)Description
Returns the number of elements in an array.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The array to calculate the number of elements for.
|
Return Value
The number of elements in an 'array'.
Count
Declaration
int Count(OLAPElementXMLAArray array)Description
Returns the number of elements in an array.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The array to calculate the number of elements for.
|
Return Value
The number of elements in an 'array'.
Count
Declaration
int Count(IntArray array)Description
Returns the number of elements in an array.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The array to calculate the number of elements for.
|
Return Value
The number of elements in an 'array'.
Count
Declaration
int Count(DoubleArray array)Description
Returns the number of elements in an array.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The array to calculate the number of elements for.
|
Return Value
The number of elements in an 'array'.
Count
Declaration
int Count(StringList list)Description
Returns the number of elements in a list.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
list
|
The list to calculate the number of elements for.
|
Return Value
The number of elements in a 'list'.
Count
Declaration
int Count(IntDictionary dictionary)Description
Returns the number of key/value pairs stored in the dictionary.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
dictionary
|
Dictionary to count number of key/value pairs for.
|
Return Value
The number of key/value pairs stored in the dictionary.
Count
Declaration
int Count(StringDictionary dictionary)Description
Returns the number of key/value pairs stored in the dictionary.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
dictionary
|
Dictionary to count number of key/value pairs for.
|
Return Value
The number of key/value pairs stored in the dictionary.
Count
Declaration
int Count(DoubleDictionary dictionary)Description
Returns the number of key/value pairs stored in the dictionary.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
dictionary
|
Dictionary to count number of key/value pairs for.
|
Return Value
The number of key/value pairs stored in the dictionary.
Count
Declaration
int Count(BoolDictionary dictionary)Description
Returns the number of key/value pairs stored in the dictionary.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
dictionary
|
Dictionary to count number of key/value pairs for.
|
Return Value
The number of key/value pairs stored in the dictionary.
Count
Declaration
int Count(OLAPElementList elementList)Description
Returns the number of elements in an OLAPElementList.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
elementList
|
The list to return number of elements of.
|
Return Value
The number of elements in elementList.
Count
Declaration
int Count(OLAPCubeList cubeList)Description
Returns the number of cubes in an OLAPCubeList.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
cubeList
|
The list to return number of cubes of.
|
Return Value
The number of cubes in cubeList.
Count
Declaration
int Count(OLAPDimensionList dimensionList)Description
Returns the number of dimensions in an OLAPDimensionList.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
dimensionList
|
The list to return number of dimensions of.
|
Return Value
The number of dimensions in dimensionList.
Count
Declaration
int Count(OLAPAttributeTableList attributeTableList)Description
Returns the number of dimensions in an OLAPDimensionList.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
attributeTableList
|
The list to return number of dimensions of.
|
Return Value
The number of dimensions in dimensionList.
Count
Declaration
int Count(XMLADimensionList dimensionList)Description
Returns the number of dimensions in an OLAPDimensionList.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
dimensionList
|
The list to return number of dimensions of.
|
Return Value
The number of dimensions in dimensionList.
Count
Declaration
int Count(XMLAHierarchyList hierarchyList)Description
Returns the number of dimensions in an OLAPDimensionList.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
hierarchyList
|
The list to return number of dimensions of.
|
Return Value
The number of dimensions in dimensionList.
Count
Declaration
int Count(XMLAMemberList memberList)Description
Returns the number of dimensions in an OLAPDimensionList.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
memberList
|
The list to return number of dimensions of.
|
Return Value
The number of dimensions in dimensionList.
CreateDoubleArray
Declaration
DoubleArray CreateDoubleArray()Description
Creates an empty DoubleArray.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
An empty DoubleArray.
CreateDoubleArray
Declaration
DoubleArray CreateDoubleArray(DoubleArray array)Description
Creates and initializes a new DoubleArray.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
Array to be used for initialization.
|
Return Value
A new and initialized DoubleArray.
CreateIntArray
Declaration
IntArray CreateIntArray()Description
Creates an empty IntArray.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
An empty IntArray.
CreateIntArray
Declaration
IntArray CreateIntArray(IntArray array)Description
Creates and initializes a new IntArray.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
Array to be used for initialization.
|
Return Value
A new and initialized IntArray.
CreateJsonArray
Declaration
JsonArray CreateJsonArray()Description
Creates and initializes an empty JsonArray instance.
Supported Runtime Versions
5.0
Parameters
The function has no parameters.
Return Value
New JsonArray instance.
CreateJsonArray
Declaration
JsonArray CreateJsonArray(string jsonString)Description
Creates and initializes a JsonArray instance from given json string.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
jsonString
|
String which should be deserialized to a JsonArray.
|
Return Value
New JsonArray instance.
CreateOLAPElementNativeArray
Declaration
OLAPElementNativeArray CreateOLAPElementNativeArray()Description
Creates an empty array of native OLAP element names.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
An empty OLAPElementNativeArray.
CreateOLAPElementNativeArray
Declaration
OLAPElementNativeArray CreateOLAPElementNativeArray(OLAPElementNativeArray array)Description
Creates and initializes an array of native OLAP element names.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
Array to be used for initialization.
|
Return Value
A new and initialized OLAPElementNativeArray.
CreateOLAPElementXMLAArray
Declaration
OLAPElementXMLAArray CreateOLAPElementXMLAArray()Description
Creates an empty array of XMLA OLAP element names.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
An empty OLAPElementXMLAArray.
CreateOLAPElementXMLAArray
Declaration
OLAPElementXMLAArray CreateOLAPElementXMLAArray(OLAPElementXMLAArray array)Description
Creates and initializes an array of XMLA OLAP element names.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
Array to be used for initialization.
|
Return Value
A new and initialized OLAPElementXMLAArray.
CreateStringArray
Declaration
StringArray CreateStringArray()Description
Creates an empty string array.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
An empty StringArray.
CreateStringArray
Declaration
StringArray CreateStringArray(StringArray array)Description
Creates and initializes a new string array.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
Array to be used for initialization.
|
Return Value
A new and initialized StringArray.
CreateStringList
Declaration
StringList CreateStringList()Description
Creates an empty string list.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
An empty StringList.
CreateStringListList
Declaration
StringListList CreateStringListList()Description
Creates an empty StringListList.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
The function has no parameters.
Return Value
An empty StringListList.
CreateStringListList
Declaration
StringListList CreateStringListList(StringList item)Description
Creates a StringListList.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
item
|
First item to be put into StringListList.
|
Return Value
An empty StringListList.
CreateVariantList
Declaration
VariantList CreateVariantList()Description
Creates an empty variant list.
Supported Runtime Versions
5.0
Parameters
The function has no parameters.
Return Value
An empty VariantList.
Find
Declaration
int Find(StringList list, string value)Description
Finds a string in the StringList.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
list
|
The list to remove element from.
|
value
|
The name of the element to be found.
|
Return Value
The index of first occurrence, or -1 if not found.
GetElementByIndex
Declaration
string GetElementByIndex(StringArray array, int index)Description
Returns an element having a certain index.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The array to get the element from.
|
index
|
Index of the element to be returned. Index starts at 0.
|
Return Value
The element with the index 'index' in 'array'.
GetElementByIndex
Declaration
OLAPElementNative GetElementByIndex(OLAPElementNativeArray array, int index)Description
Returns an element having a certain index.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The array to get the element from.
|
index
|
Index of the element to be returned. Index starts at 0.
|
Return Value
The element with the index 'index' in 'array'.
GetElementByIndex
Declaration
OLAPElementXMLA GetElementByIndex(OLAPElementXMLAArray array, int index)Description
Returns an element having a certain index.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
array
|
The array to get the element from.
|
index
|
Index of the element to be returned. Index starts at 0.
|
Return Value
The element with the index 'index' in 'array'.
GetElementByIndex
Declaration
string GetElementByIndex(StringList list, int index)Description
Returns an element having a certain index.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
list
|
The list to get the element from.
|
index
|
Index of the element to be returned. Index starts at 0.
|
Return Value
The element with the index 'index' in 'list'.
Insert
Declaration
void Insert(StringList list, int index, string element)Description
Inserts a string into the StringList.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
list
|
The list to insert to.
|
index
|
The index of the new element.
|
element
|
The element to be inserted.
|
Return Value
Does not return a value.
MergeDistinct
Declaration
StringList MergeDistinct(StringList list1, StringList list2)Description
Merges two StringList objects and eliminates duplicate values.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
list1
|
The first list to be merged.
|
list2
|
The second list to be merged.
|
Return Value
A new list that contains all values from list1 and list2 and does not contain duplicates.
Prepend
Declaration
void Prepend(StringList list, string element)Description
Prepends a string to the StringList.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
list
|
The list to prepend.
|
element
|
The element to prepend.
|
Return Value
Does not return a value.
Remove
Declaration
void Remove(VariantDictionary dictionary, Variant key)Description
Removes the value with the specified key from the dictionary.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
dictionary
|
The dictionary to remove the key/value pair from.
|
key
|
Key of the value to be removed.
|
Return Value
True, if the element was found and removed. False, if the key does not exist in the dictionary.
Remove
Declaration
bool Remove(JsonDictionary dictionary, string key)Description
Removes property of given name from JsonDictionary.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
dictionary
|
JsonDictionary instance.
|
key
|
Name of the property.
|
Return Value
True if property was found and removed. False, if the property does not exist in the dictionary.
Remove
Declaration
void Remove(JsonArray array, int index)Description
Removes an item from given JsonArray.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
array
|
JsonArray instance from which to remove an item.
|
index
|
Index of removed item.
|
Return Value
Does not return a value.
Remove
Declaration
void Remove(StringList list, int index)Description
Removes a string from the StringList.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
list
|
The list to remove element from.
|
index
|
The index of the element to be removed.
|
Return Value
Does not return a value.
Remove
Declaration
bool Remove(IntDictionary dictionary, string key)Description
Removes the value with the specified key from the dictionary.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
dictionary
|
The dictionary to remove the key/value pair from.
|
key
|
Key of the value to be removed.
|
Return Value
True, if the element was found and removed. False, if the key does not exist in the dictionary.
Remove
Declaration
bool Remove(StringDictionary dictionary, string key)Description
Removes the value with the specified key from the dictionary.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
dictionary
|
The dictionary to remove the key/value pair from.
|
key
|
Key of the value to be removed.
|
Return Value
True, if the element was found and removed. False, if the key does not exist in the dictionary.
Remove
Declaration
bool Remove(DoubleDictionary dictionary, string key)Description
Removes the value with the specified key from the dictionary.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
dictionary
|
The dictionary to remove the key/value pair from.
|
key
|
Key of the value to be removed.
|
Return Value
True, if the element was found and removed. False, if the key does not exist in the dictionary.
Remove
Declaration
bool Remove(BoolDictionary dictionary, string key)Description
Removes the value with the specified key from the dictionary.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description
|
|---|---|
dictionary
|
The dictionary to remove the key/value pair from.
|
key
|
Key of the value to be removed.
|
Return Value
True, if the element was found and removed. False, if the key does not exist in the dictionary.
RemoveAll
Declaration
int RemoveAll(StringList list, string value)Description
Removes all occurrences of a string from the StringList.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
list
|
The list to remove element from.
|
value
|
The name of the element to be removed.
|
Return Value
Number of removed instances.
ToStringArray
Declaration
StringArray ToStringArray(StringList list)Description
Converts a StringList into a StringArray.
Supported Runtime Versions
4.0, 5.0
Parameters
|
Description
|
|---|---|
list
|
The StringList to be converted.
|
Return Value
A new StringArray that contains the same elements as list.