ExcelSetSheetName

From GECK
Jump to: navigation, search


A function added by the SUP NVSE Plugin.

Description

Sets name to specified sheet of specified Excel file. Will return name of the sheet if last parameter is ommited.

Syntax

[help]
(Name:string) ExcelSetSheetName filepath:string WorksheetID:int Name:string

Example

ExcelSetSheetName "aaExcelFile" 0 "MyName"

Will set "MyName" as a name for sheet with index 0 of "aaExcelFile.xls"

let s_Name := ExcelSetSheetName "aaExcelFile" 0

Will return name of Sheet with index 0 of file "aaExcelFile.xls"

Notes

  • if file doesn't exists or can't be loaded (i.e. - it's open in Excel at the moment) - function returns -1.
  • Max name length is 31 symbols(if passed string exceeds the limit it will be automaticcaly shortened).

See Also