ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Standard functions / Queue, stack, list and array functions / Array functions
  • Inserting a row
  • Inserting a row into an advanced array property
  • Miscellaneous
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Inserts a row at a given position:
  • into a two-dimensional WLanguage array.
  • into an advanced two-dimensional array property (xlsDocument, etc.).
Remark: This function is equivalent to InsertLine.
Example
MyArray is array of 2 by 3 strings
ArrayInsertLine(MyArray, 1, "A", "B", "C")
ArrayInsertLine(MyArray, 2, "a", "b", "c")
ArrayInsertLine(MyArray, 3, "D", "E", "F")
// Display the content of the 3rd row
Trace(MyArray[3,1], MyArray[3,2], MyArray[3,3])
// Displays "D E F"
Syntax
ArrayInsertLine(<WLanguage array> , <Insertion index> [, <Element column 1> [... [, <Element column N>]]])
<WLanguage array>: Array
Name of the Array variable to use. This array must be a two-dimensional array.
<Insertion index>: Integer
Index where the row must be inserted. From this index, all rows will move by 1 position.
If <Insertion index> is equal to the number of rows in the array + 1, the row is added at the last position in the array (equivalent to ArrayAddLine).
A WLanguage error occurs if <Insertion index> is greater than the number of rows in the array + 1.
<Element column 1>: Type of array elements, optional
Element of the row that will be added into the specified array. Each element corresponds to a column in the array. The type of the added element must be compatible with the type of relevant column.
If none of these parameters is specified, an empty row is added to the array. The columns are initialized with the default value of the type of the other array elements.
If one of these parameters is not specified, the corresponding column is initialized with the default value of the type of the other array elements.
<Element column N>: Type of array elements, optional
Element of the row that will be added into the specified array. Each element corresponds to a column in the array. The type of the added element must be compatible with the type of relevant column.
If none of these parameters is specified, an empty row is added to the array. The columns are initialized with the default value of the type of the other array elements.
If one of these parameters is not specified, the corresponding column is initialized with the default value of the type of the other array elements.
Remarks

Inserting a row

When ArrayInsertLine is called:
  • the array is automatically enlarged to receive the new row.
  • the elements are converted (if necessary) into the type of the other array elements.
Remark: When declaring an array of N by M elements, this array contains N empty rows. For example, the array declared below contains 3 empty rows.
MyArray is array of 3 by 2 strings
Rows inserted using ArrayInsertLine are automatically inserted among the existing rows in the array.
In our example, the array will contain 4 rows once the insertion is performed.

Inserting a row into an advanced array property

When ArrayInsertLine is called:
  • the advanced variable must be created.
  • the advanced type must have an enumerator of modifiable collection type.
  • the advanced type is automatically enlarged to receive the new row.

Miscellaneous

  • This function cannot be used on:
    • non-created arrays,
    • fixed arrays.
Component: wd290vm.dll
Minimum version required
  • Version 10
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 05/26/2022

Send a report | Local help