saveToDocStore script operation
Saves an updated ExcelBook to the documentation store. If used in an export script with no operands, then the Excel file will be written into the standard export directory with name CATALOG.XLS. If run with no operands outside of an export, then this script operation will fail with an exception. When a docStorePath argument is supplied, then this is absolute path including the file name where the excel book will be written in the doc store. When the overWriteFlag is set to true, then any existing excel book at the supplied path will be overwritten, If the overWriteFlag is set to false and excelbook existing in the docstore path, an exception will be thrown. If the overwriteFlag is not supplied, then it will default to false. It is recommended that you do not specify a docstore path in export scripts, as subsequent runs of the export will attempt to write to the same file in the doc store (which will only succeed if the overwrite flag is set to true).
Format: ObjectOriented
Type: method
Syntax
void ExcelBook::saveToDocStore([[docStorePath docStorePath],Boolean overwriteFlag]])
Parameters
| Type | Name | Description | Is required? | Is array? |
|---|---|---|---|---|
| ExcelBook | operatesOn | The ExcelBook context. | false | false |
| docStorePath | docStorePath | The path, in the docstore, of where to save the ExcelBook. | false | false |
| Boolean | overwriteFlag | If set, to true overwrites any existing, matching ExcelBok in the document store. | false | false |
Return values
Return value: void
Is array: false