MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

expand docs for open and close functions

develop
myk002 2021-03-22 10:44:32 -07:00
parent 4ef0ff2a24
commit 222feff342
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/Lua API.rst
Unescape Escape View File

@ -4307,12 +4307,14 @@ xlsxreader
Utility functions to facilitate reading .xlsx spreadsheets. It provides the Utility functions to facilitate reading .xlsx spreadsheets. It provides the
following low-level API methods: following low-level API methods:
- ``open_xlsx_file(filename)`` returns an open file_handle - ``open_xlsx_file(filename)`` returns a file_handle or nil on error
- ``close_xlsx_file(file_handle)`` - ``close_xlsx_file(file_handle)`` closes the specified file_handle
- ``list_sheets(file_handle)`` returns a list of strings representing sheet - ``list_sheets(file_handle)`` returns a list of strings representing sheet
names names
- ``open_sheet(file_handle, sheet_name)`` returns a sheet_handle - ``open_sheet(file_handle, sheet_name)`` returns a sheet_handle. This call
- ``close_sheet(sheet_handle)`` always succeeds, even if the sheet doesn't exist. Non-existent sheets will
have no data, though.
- ``close_sheet(sheet_handle)`` closes the specified sheet_handle
- ``get_row(sheet_handle, max_tokens)`` returns a list of strings representing - ``get_row(sheet_handle, max_tokens)`` returns a list of strings representing
the contents of the cells in the next row. The ``max_tokens`` parameter is the contents of the cells in the next row. The ``max_tokens`` parameter is
optional. If set to a number > 0, it limits the number of cells read and optional. If set to a number > 0, it limits the number of cells read and