Reads worksheet names from a workbook without loading worksheet contents. Returns the number of sheet names read, or -1 if the input cannot be opened as a supported workbook.
Syntax
function GetSheetNames(FileName: WideString; AList: TStrings): Integer; overload;
function GetSheetNames(Stream: TStream; AList: TStrings): Integer; overload;
| FileName |
WideString. The XLS or XLSX file to inspect. |
| Stream |
TStream. A classic XLS workbook stream or XLSX package stream positioned at the workbook data to inspect. |
| AList |
TStrings. The method clears this list and appends sheet names in workbook order. |
Remarks
Both overloads scan the workbook globals stream in Excel 97-2003 .xls files and
xl/workbook.xml in XLSX packages. Use
Open when cell data, formatting, formulas, or worksheet objects are required.
Example
This example reads sheet names from a workbook.
var
Workbook: IXLSWorkbook;
Names: TStringList;
begin
Workbook := TXLSWorkbook.Create;
Names := TStringList.Create;
try
if Workbook.GetSheetNames('book.xlsx', Names) >= 0 then
ShowMessage(Names.Text);
finally
Names.Free;
end;
end;