AddColumn (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Queue, stack, list and array management functions

See also

Array management functions

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 iPhone/iPad applications.

New in version 19

This function is now available for 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(<WLanguage array> [, <Element row 1> [... [, <Element row N>]]])

<Result>: Integer

Index of the new column,
-1 if an error occurred.

<WLanguage array>: Array

Name of the 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 AddColumn 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 column.
the rows are initialized with the values passed as parameter. If no value is passed in parameter, the rows are initialized with the default value of the type of the array elements.

Component: wd270vm.dll