AddColumn (Function)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Functions for managing arrays

AddColumn (Function)

In french: AjouteColonne

Adds a column at the end of a two-dimensional array property (xlsDocument variable for example).

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 19 and later

This function is now available for the iPhone/iPad applications.

New in version 19

This function is now available for the iPhone/iPad applications.

Versions 21 and later

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

Syntax

<Result> = AddColumn(<Array Name> [, <Element Row 1> [... [, <Element Row N>]]])

<Result>: Integer

Subscript of added column,
-1 if an error occurred.

<Array Name>: Array

Name of Array variable to use. This array must be a one-dimensional array or a two-dimensional array.

<Element Row 1>: Type of array elements, optional

Element of the column that will be added into the specified array. Each element corresponds to a row in the array. The type of the added element must be compatible with the type of the relevant row.
If none of these parameters is specified, an empty column is added to the array. The rows are initialized with the default value of the type of the other array elements.
If one of these parameters is not specified, the corresponding row is initialized with the default value of the type of the other array elements.

<Element Row N>: Type of array elements, optional

Element of the column that will be added into the specified array. Each element corresponds to a row in the array. The type of the added element must be compatible with the type of the relevant row.
If none of these parameters is specified, an empty column is added to the array. The rows are initialized with the default value of the type of the other array elements.
If one of these parameters is not specified, the corresponding row is initialized with the default value of the type of the other array elements.

Remarks

When using AddColumn:

the advanced variable must be allocated.
the advanced type must have an enumerator of modifiable collection type.
the advanced type is automatically enlarged to receive the new column.
the rows are initialized with the values passed in parameter. If no value is passed in parameter, the rows are initialized with the default value of the type of the array elements.

Component : wd240vm.dll