Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

XL.LoadBookInfo

Loads a Excel file metadata.

Component Version macOS Windows Linux Server iOS SDK
XL 16.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "XL.LoadBookInfo"; Data { ; Type; Password } )   More

Parameters

Parameter Description Example Flags
Data Either text with file path or container value which contains the Excel file data. "C:\test\test.xls"
Type Which type of file this is.
Pass 0 for unknown, 1 to try xml format (xlsx) and 2 to try binary format (xls).
Default is 0 to detect automatically.
0 Optional
Password Optional password for reading password protected files.
Requires LibXL 5.0.
"secure password" Optional

Result

Returns book reference number on success or error.

Description

Loads a Excel file metadata.
Loads only information about sheets. After loading, you may check XL.Book.SheetCount and XL.Book.SheetName for the sheet names.

Works with both XML based xlsx files and older xls files.
Book reference numbers are starting at 19000 and counting up for each new book.

Examples

Load sheet metadata:

Set Variable [ $bookRef ; Value: MBS( "XL.LoadBookInfo"; "/Users/cs/Desktop/test.xlsx") ]

See also

Release notes

  • Version 16.1
    • Added XL.LoadBookInfo function.

Blog Entries

This function checks for a license.

Created 25th January 2026, last changed 25th January 2026


XL.LoadBook - XL.LoadBookPartially