Array user defined functions Reference

Below is a complete list of the user defined functions available in AutoIt. Click on a user defined function name for a detailed description.

When using them you need to add a #include <Array.au3>.

 

User Defined Function Description
_Array1DToHistogram Transform a 1D array to Histogram
_ArrayAdd Adds a specified value at the end of an existing 1D or 2D array
_ArrayBinarySearch Uses the binary search algorithm to search through a 1D or 2D array
_ArrayColDelete Deletes a specified column from a 2D array
_ArrayColInsert Inserts a specified column into a 1D or 2D array
_ArrayCombinations Returns an array of the combinations of a set of elements from a selected 1D array
_ArrayConcatenate Concatenate two arrays - either 1D or 2D with the same number of columns
_ArrayDelete Deletes the specified element(s) from the specified 1D or 2D array
_ArrayDisplay Displays a 1D or 2D array as a ListView
_ArrayExtract Extracts an array from the specified element(s) of a 1D or 2D array
_ArrayFindAll Find the indices of all ocurrences of a search query between two points in a 1D or 2D array using _ArraySearch()
_ArrayInsert Insert a new value at the specified position of a 1D or 2D array
_ArrayMax Returns the highest value held in a 1D or 2D array
_ArrayMaxIndex Returns the index where the highest value occurs in a 1D or 2D array
_ArrayMin Returns the lowest value held in a 1D or 2D array
_ArrayMinIndex Returns the index where the lowest value occurs in a 1D or 2D array
_ArrayPermute Returns an array of the Permutations of all Elements in a 1D array
_ArrayPop Returns the last element of an array, deleting that element from the array at the same time
_ArrayPush Add new values without increasing array size by inserting at the end the new value and deleting the first one or vice versa
_ArrayReverse Takes the given array and reverses the order in which the elements appear in a 1D array
_ArraySearch Finds an entry within a 1D or 2D array. Similar to _ArrayBinarySearch(), except that the array does not need to be sorted
_ArrayShuffle Shuffles selected rows of 1D or 2D arrays - can be limited to a specific column in 2D arrays
_ArraySort Sort a 1D or 2D array on a specific index using the dualpivotsort/quicksort/insertionsort algorithms
_ArraySwap Swaps elements of a 1D array and full or part rows/columns of a 2D array
_ArrayToClip Sends the contents of a 1D or 2D array to the clipboard, each element separated by a specified delimiter
_ArrayToString Places the elements of a 1D or 2D array into a single string, separated by the specified delimiters
_ArrayTranspose Transposes a 1D or 2D array (swaps rows and columns)
_ArrayTrim Trims a certain number of characters from all elements in a 1D or 2D array
_ArrayUnique Returns the Elements from a column of a 1D or 2D array, removing all duplicates