xlsNbColumn (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Number of columns: taking the empty columns into account

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

xlsNbColumn (Function)

In french: xlsNbColonne

Returns the number of columns found in a worksheet of an XLS file. The result depends on the opening mode of XLS file:

In multi-sheet mode, the number of columns is calculated for the worksheet selected by xlsCurrentWorksheet.
In compatible mode, the number of columns is always calculated for the first worksheet of the workbook.

This function assumes that the XLS file has a database structure, which means that each row corresponds to a fixed number of columns.

Remark: The number of columns in an XLS file can be found if:

The XLS file exists.
The XLS file is opened.

Versions 16 and later

This function is now available for WINDEV applications in Linux.

This function is now available for WEBDEV sites in Linux.

New in version 16

This function is now available for WINDEV applications in Linux.

This function is now available for WEBDEV sites in Linux.

This function is now available for WINDEV applications in Linux.

This function is now available for WEBDEV sites in Linux.

Example

See additional examples

// Open an XLS file
XLSFileID = xlsOpen("C:\MyDirectory\File.XLS")
IF XLSFileID <> -1 THEN
// Number of columns
ResNbColumns = xlsNbColumn(XLSFileID)
...
END

Syntax

Syntax that is using the xlsDocument type Hide the details

<Result> = xlsNbColumn(<XLS document> [, <Empty columns>])

<Result>: Integer

Number of columns in the specified XLS file
-1 if an error occurred (XLS file not opened for example). To find out the error details, use xlsMsgError or ErrorInfo associated with the errMessage constant.

<XLS document>: xlsDocument variable

Name of xlsDocument variable corresponding to the XLS file to use.

<Empty columns>: Optional boolean

Mode for taking the empty columns into account:
True
(by default) The columns that are entirely empty are ignored
False The columns that are entirely empty are taken into account

Syntax kept for backward compatibility with version 12 Hide the details

<Result> = xlsNbColumn(<Identifier of XLS file> [, <Empty columns>])

<Result>: Integer

Number of columns in the specified XLS file,
-1 if an error occurred (XLS file not opened for example). For more details on the error, use xlsMsgError or ErrorInfo with the constant errMessage.

<Identifier of XLS file>: Integer

Identifier of XLS file to handle, returned by xlsOpen.

<Empty columns>: Optional boolean

Mode for taking the empty columns into account:
True
(by default) The columns that are entirely empty are ignored
False The columns that are entirely empty are taken into account

Remarks

Number of columns: taking the empty columns into account

The empty columns can be taken into account or not. For example:

xlsNbColumn(XLSFileID, True) // Returns "3"
xlsNbColumn(XLSFileID, False) // Returns "4"

Component : wd260xls.dll