PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Number of columns: taking the empty columns into account
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
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.
Note: 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
WINDEVLinux This function is now available for the WINDEV applications in Linux.
WEBDEV - Server codeLinux This function is now available for the WEBDEV sites in Linux.
New in version 16
WINDEVLinux This function is now available for the WINDEV applications in Linux.
WEBDEV - Server codeLinux This function is now available for the WEBDEV sites in Linux.
WINDEVLinux This function is now available for the WINDEV applications in Linux.
WEBDEV - Server codeLinux This function is now available for the WEBDEV sites in Linux.
// 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
FalseThe 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). To find out the error details, use xlsMsgError or ErrorInfo associated with the errMessage constant.
<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
FalseThe 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"
Components
WINDEVWEBDEV - Server codeReports and Queries wd230xls.dll
Linux wd230xls.so
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment