xlsOpen (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Using the XLS functions in read/write
The XLS file cannot be opened

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

xlsOpen (Function)

In french: xlsOuvre

Opens an Excel file (xls or xlsx files).

Remark: To create an Excel file without using an initial file, all you have to do is create an xlsDocument variable (in this case, xlsOpen is useless).

Versions 16 and later

This function is now available for WINDEV applications in Linux.

This function is now available for WEBDEV sites in Linux.

Only the xlsx format is supported.

New in version 16

This function is now available for WINDEV applications in Linux.

This function is now available for WEBDEV sites in Linux.

Only the xlsx format is supported.

This function is now available for WINDEV applications in Linux.

This function is now available for WEBDEV sites in Linux.

Only the xlsx format is supported.

Example

See additional examples

Example used to open an Excel file while retrieving an integer

doc is xlsDocument
doc = xlsOpen(fExeDir() + ["\"] + "gpac.xls")

IF ErrorOccurred() THEN
Error(ErrorInfo())
RETURN
END

Info("Content of [1,1] cell:", doc[1,1])

xlsClose(doc)

Syntax

<Result> = xlsOpen(<Path of XLS file> [, <Opening mode> [, <Password>]])

<Result>: Integer or xlsDocument variable

Name of the xlsDocument variable corresponding to the XLS file. This variable can be used by all the XLS functions. Using this type of variable allows you to modify the XLS documents.
Identifier of specified XLS file. This identifier will be used by all the XLS functions. Syntax kept for backward compatibility with version 12. This syntax with identifier can only be used to read the XLS documents: no modification is possible.
The ErrorOccurred variable is set to True if an error occurred and ErrorInfo returns the error details.

<Path of XLS file>: Character string

Full or relative path of XLS file to open (up to 260 characters).

<Opening mode>: Optional integer constant

Indicates the opening mode of XLS file.
By default:
the Excel file is opened in read-only mode. You can write to the Excel file with another application.
the Excel file uses the multi-sheet management mode for XLS files.
xlsWrite Opens the Excel file in "Read/Write" mode: the XLS file is opened and locked until it is closed.
Caution: the modifications performed in the XLS file will be taken into account only if you are using an xlsDocument variable.
xlsCompatible Used to open the Excel file in mode compatible with version 10.
In this mode:
A single workbook sheet is supported.
Unicode is not supported.
The groups of strings are not supported.
Some functions (xlsData or xlsNbRow for example) may return inconsistent results.
Warning
From version 11, this constant is available for backward compatibility.

<Password>: Optional character string (with quotes)

Versions 24 and later
Password to open the XLS file to use.
New in version 24
Password to open the XLS file to use.
Password to open the XLS file to use.

Remarks

Using the XLS functions in read/write

To handle the XLS files in read/write, you must use an xlsDocument variable. This type of variable can also be used to handle the files specific to Office 2007 (.xlsx files) in read/write.

The use of the file identifier is kept for backward compatibility with version 12. The XLS documents (including the ".xlsx" files specific to Office 2007) handled with this identifier cannot be modified (even if the xlsWrite constant is specified).

Example using the syntax kept for backward compatibility:

XLSFileID is int
XLSFileID = xlsOpen(CompleteDir(fExeDir()) + "GPACS.XLS")
IF ErrorOccurred = False THEN
Info("The XLS file was opened")
// Close the file
xlsClose(XLSFileID)
ELSE
Info(ErrorInfo())
END
END

The XLS file cannot be opened

The possible error cases are as follows:

The specified XLS file was not found.
The specified XLS file does not exist.
The specified XLS file cannot be opened.
The specified XLS file is invalid.
Insufficient memory to open the XLS file.
The version of Excel used is unknown or too old (the XLS functions cannot read the files in Excel version 2 or earlier).

To find out the error details, call xlsMsgError (if you are using the syntax compatible with version 12) or ErrorInfo associated with the errMessage constant.

Component : wd250xls.dll