Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4i

Application v 5.22a

  

 

Chapter Six — File Functions

Chapter Contents

6.1 File Functions
6.1.1 Overview
6.1.2 Introduction to Files
6.1.3 Filename Encoding
6.1.4 Using Files
6.2 File Access Modes
6.2.1 Access Modes
6.2.2 File Mode Codes
6.3 Low-Level File Functions
6.3.1 Overview
6.3.2 Understanding File Handles
6.3.3 Short File and Path Names
6.3.4 File Functions
BufferToFile Function
CanAccessFile Function
CloseFile Function
CreateFile Function
CreateFolder Function
CreateFolders Function
DeleteFile Function
DeleteFolder Function
DoesFileExist Function
DoesPathExist Function
EnumerateFiles Function
EnumerateFolderDetails Function
EnumerateFolders Function
EnumeratePlaces Function
EnumerateShares Function
FileToBuffer Function
FileToString Function
GetAbsoluteFilePosition Function
GetCorrectedFilename Function
GetFileAttributeString Function
GetFileAttributeBits Function
GetFileCreateTime Function
GetFileCreateTimeString Function
GetFileLockMetaData Function
GetFileModifiedTime Function
GetFileModifiedTimeString Function
GetFileOpenStatus Function
GetFilePosition Function
GetFileSize Function
GetFirstFile Function
GetLongFilename Function
GetLongPathName Function
GetNextFile Function
GetShortFilename Function
GetShortPathName Function
GetTempFile Function
GetVolumeFreeSpace Function
GetVolumeLabel Function
GetVolumeSerialNumber Function
GetVolumeSize Function
GetVolumeType Function
GetUNCLabel Function
GetUNCLabelOnly Function
GetWorkingDirectory Function
GetWorkingFolder Function
IsFile Function
IsFolder Function
OpenFile Function
PathToUNC Function
QueryOverwrite Function
QueryReadOnlyOverwrite Function
ReadBlock Function
ReadLine Function
RecycleFile Function
RenameFile Function
ReportFileError Function
ReportFileOpenStatus Function
SetFilePosition Function
SetFilePositionAtEnd Function
SetFileTime Function
SetWorkingDirectory Function
SetWorkingFolder Function
StringToFile Function
TruncateFilePosition Function
VariableToFile Function
WriteBlock Function
WriteLine Function
6.4 File String and Path Functions
6.4.1 Overview
6.4.2 Paths
6.4.3 Path String Functions
AddPathDelimiter Function
AddPaths Function
ApplyDefaultPath Function
CatPaths Function
ClipFileExtension Function
ClipIDReference Function
ClipQueryOrID Function
ClipURIFilename Function
ClipURIPath Function
CollapsePath Function
CreateRelativePath Function
DecodeURI Function
EncodeURIComponent Function
ExpandEnvironmentalStrings Function
GetAdjustURLFilename Function
GetApplicationDataFolder Function
GetApplicationDataCommonFolder Function
GetApplicationDataLocalFolder Function
GetApplicationExecuteFolder Function
GetApplicationFilename Function
GetApplicationSettingsName Function
GetDesktopFolder Function
GetDrive Function
GetExtension Function
GetFilename Function
GetFilePath Function
GetIDReference Function
GetPathConnector Function
GetProgramFilesFolder Function
GetSystemFolder Function
GetTempFileFolder Function
GetUNC Function
GetUNCShareName Function
GetURIAuthority Function
GetURIComponents Function
GetURIHost Function
GetURIName Function
GetURIPath Function
GetURIQuery Function
GetURISchemeString Function
GetURISchemeType Function
HasURIScheme Function
IsFilenameValid Function
IsInTempFolder Function
IsPath Function
IsPathDrive Function
IsPathQualified Function
IsPathUNC Function
IsPathQualifiedWeb Function
IsPathQualifiedWindows Function
IsPathTopLevel Function
IsSamePath Function
MakePathRelative Function
PathLevelUp Function
PathToMSDelimiters Function
PathToURIDelimiters Function
QualifyURL Function
URIArrayToQuery Function
URIQueryToArray Function
6.5 File System
6.5.1 Overview
6.5.2 Volumes
6.5.3 Virtual File Cloud
6.5.4 Related Functions
AttachFileCloud Function
DoesVolumeSupportHidden Function
DoesVolumeSupportRecycling Function
DoesVolumeSupportWriting Function
EnumerateFileClouds Function
EnumerateOpenFiles Function
GetFileCloudCount Function
GetFileCloudProperties Function
GetFileCloudRoot Function
GetMaxFileClouds Function
IsFileCloudEnabled Function
ReleaseFileCloud Function
SetFileCloudProperties Function
6.6 Mapped Text Objects
6.6.1 Overview
6.6.2 Entry Point Table
6.6.3 Supporting the Application Frame
6.6.4 File Locking
6.6.5 Opening a File
6.6.6 Non-Transaction Line Access
6.6.7 Transaction Based Segment Access
6.6.8 Other Things to Note
6.6.9 Related Functions
CreateMappedTextFile Function
CreateMappedTextString Function
DeleteLine Function
GetLineCount Function
GetLineSize Function
GetMappedTextEncoding Function
GetMappedTextEncodingString Function
GetMappedTextFilename Function
GetMappedTextFileType Function
InsertLine Function
IsBlankLine Function
MappedTextExport Function
MappedTextGetEditWindow Function
MappedTextSave Function
MappedTextToString Function
MoveToNonBlankLine Function
OpenMappedTextFile Function
ReadSegment Function
ReplaceLine Function
WriteSegment Function
6.7 Edit Objects
6.7.1 Overview
6.7.2 Related Functions
6.8 Whole File Operations
6.8.1 Overview
6.8.2 File Compression
6.8.3 Whole File Functions
CompressFile Function
DecompressFile Function
ZipCreate Function
ZipAddFile Function
ZipWrite Function
ZipOpen Function
ZipEnumerateEntries Function
ZipEnumerateFiles Function
ZipEnumerateFolders Function
ZipExtractFile Function
ZipExtractToFolder Function
ZipExtractToString Function
ZipFindEntry Function
ZipGetEntryProps Function
ZipGetEntryCompressionType Function
ZipGetEntryCount Function
ZipGetEntryName Function
ZipGetEntrySize Function
ZipGetFolderCount Function
CopyFile Function
DecodeFile Function
EncodeFile Function
6.9 MIME Encoding
6.9.1 Overview
6.9.2 Encoding
6.9.3 Header
6.9.4 Attachments, Files and Data
6.9.5 Functions
MIMEEnumerateItems Function
MIMEItemToFile Function
MIMEItemToString Function
MIMEGetItemProperties Function
MIMEGetProperties Function
MIMEOpen Function
6.10 File Types
6.10.1 Overview
6.10.2 File Type Codes
6.10.3 Content Types
6.10.4 File Type Functions
ContentTypeToFileType Function
GetFileTypeCode Function
GetFileTypeString Function
GetFileTypeData Function
FileTypeCodeToString Function
FileTypeStringToCode Function
FileTypeToContentType Function

 

 

GoFiler Legato Script Reference — Generated on 03/19/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.