xlsColumnTitle (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Standard functions / XLS file functions

Column caption
Handling errors

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

xlsColumnTitle (Function)

In french: xlsTitreColonne

Retrieves the title of a column found in an XLS file. The result depends on the opening mode of XLS file:

In multi-sheet mode, the column title is sought for the worksheet selected by xlsCurrentWorksheet.
In compatible mode, the column title is always sought for the first worksheet of workbook.

Note: The column title of an XLS file can only be retrieved if:

The XLS file exists.
The XLS file is opened.

Example

See additional examples

// Open an XLS file
XLSFileID = xlsOpen("C:\MyDirectory\File.XLS")
IF XLSFileID <> -1 THEN
	// Retrieve the caption of a column
	ResColumnTitle = xlsColumnTitle(XLSFileID, 4)
	...
END

Syntax

Syntax that uses the xlsDocument type Hide the details

<Result> = xlsColumnTitle(<XLS document> , <Column number> [, <Empty columns>])

<Result>: Character string

Caption of specified column,
xlsTitleError constant if an error occurred. To get more details on the error, use xlsMsgError or ErrorInfo with the errMessage constant.

<XLS document>: xlsDocument variable

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

<Column number>: Integer

Number of the column to read.

<Empty columns>: Optional boolean

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

Syntax kept for backward compatibility with version 12 Hide the details

<Result> = xlsColumnTitle(<XLS file identifier> , <Column number> [, <Empty columns>])

<Result>: Character string

Caption of specified column,
xlsTitleError constant if an error occurred. To get more details on the error, use xlsMsgError or ErrorInfo with the errMessage constant.

<XLS file identifier>: Integer

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

<Column number>: Integer

Number of the column to read.

<Empty columns>: Optional boolean

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

Remarks

Column caption

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

xlsColumnTitle(XLSFileID, 3, True) // Returns "Age"
xlsColumnTitle(XLSFileID, 3, False) // Returns ""

Handling errors

xlsColumnTitle throws an error in the following cases:

The specified column is not found (negative column for example).
The specified XLS file is not opened.

Component: wd300xls.dll