xlsNbWorksheet (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Managing the Graphic worksheets

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

xlsNbWorksheet (Function)

In french: xlsNbFeuille

Returns the number of worksheets found in an XLS file.

Remark: In compatible mode, the number of worksheets is always equal to 1.

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

FileIdentifier is int

// Open an XLS file
FileIdentifier = xlsOpen("C:\My documents\MyFile.XLS")
IF FileIdentifier <> -1 THEN
// Retrieve the numbers of worksheets found in the file
Info("The file contains " + xlsNbWorksheet(FileIdentifier) + " worksheets.")
END

Syntax

Syntax that is using the xlsDocument type Hide the details

<Result> = xlsNbWorksheet(<XLS document>)

<Result>: Integer

Number of worksheets found in the XLS file,
-1 if an error occurred. 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 close. The physical file associated with this variable (if it exists) is closed. The modifications performed in the file will not be saved before it is closed (use xlsSave if necessary).

Syntax kept for backward compatibility with version 12 Hide the details

<Result> = xlsNbWorksheet(<XLS file identifier>)

<Result>: Integer

Number of worksheets found in the XLS file,
-1 if an error occurred. To get the details of the error, use xlsMsgError or ErrorInfo with the errMessage constant.

<XLS file identifier>: Integer

Identifier of the XLS file to handle, returned by xlsOpen.

Remarks

Managing the Graphic worksheets

The Excel "Graphic" worksheets are ignored. Indeed, these worksheets have no cell and therefore they cannot be accessed.

Component: wd270xls.dll