Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Complete Table of Contents

Complete Table of Contents
Chapter One — Introduction
1.1 General 
1.1.1 Introduction
1.1.2 Purpose
1.1.3 Conventions
1.1.4 Organization of Reference Manual
1.2 Overview of the Language
1.2.1 Terminology
1.3 Linking Legato to the Application
1.3.1 General
1.3.2 Debugging Hooks
Chapter Two — Language Overview
2.1 Some Simple Programs
2.1.1 Overview
2.1.2 Temperature Conversion
2.1.3 A Temperature Variation
2.1.4 Display the Contents of a Folder
2.1.5 Make a Wiki Request
2.2 Data
2.2.1 Data Used in Programming
2.2.2 Types and Sources of Data
2.2.3 Sharing Data
2.2.4 Fundamental Data Types
2.2.5 Arrays, Lists and Tables
2.3 Control and Flow
2.4 Interacting with the Application
2.5 Interacting with External Systems
2.6 Integrated Development Environment (IDE)
2.6.1 Using the IDE
2.6.2 Developing Programs
2.6.3 Preprocess
2.6.4 Crunch/Integrate
2.6.5 Sign Code
2.6.6 Running Programs
2.6.7 Program Errors
2.6.8 Program Trace
2.7 Extensions
2.7.1 Build in Functions
2.7.2 Extensions
2.7.3 Functions
EnumerateAPIFunctions Function
EnumerateExtensions Function
2.8 Debugging Tools
2.8.1 Using Trace
2.8.2 Trace Within the IDE
2.8.3 Trace Dumped to a File
2.9 Script Errors
2.9.1 Overview
2.9.2 Preprocess Errors
2.9.3 Runtime Errors
2.9.4 Functions
TranslateFormattedErrorCode Function
TranslateScriptErrorCode Function
2.10 Console and Console Applications
2.10.1 Console and Windows Applications
2.10.2 The Console Window
2.10.3 Logs
2.10.4 Console Window and Related Functions 
ConsoleClose Function
ConsoleCreate Function
ConsoleGetCharacter Function
ConsoleGetHandle Function
ConsoleGetLine Function
ConsoleOpen Function
ConsolePrint Function
ConsoleToFile Function
ConsoleToString Function
IsConsoleApplication Function
IsConsoleOpen Function
2.11 Security
2.11.1 Overview
2.11.2 Code Signing
2.11.3 Code Crunching
2.11.4 Types of Permissions
2.11.5 Secure Memory Model
2.11.6 Security Functions 
ScriptCrunch Function
ScriptGetComments Function
ScriptGetPermissions Function
ScriptSign Function
ScriptVerifySignature Function
SecureClear Function
Chapter Three — Data Types and Operators
3.1 Variables and Symbols
3.1.1 Variables
3.1.2 Declaration
3.1.3 Introduction to Data Types
3.2 Variable Scope
3.2.1 Overview
3.2.2 Global
3.3 Data Types
3.3.1 Overview
3.3.2 ‘int’ Integer (32-bit signed)
3.3.3 ‘short’ Integer (16-bit signed)
3.3.4 ‘long’ Integer (64-bit signed)
3.3.5 ‘float’ Float (64-bit)
3.3.6 ‘boolean’ Boolean 
3.3.7 ‘char’ Character (8-bit)
3.3.8 ‘byte’ Byte (8-bit)
3.3.9 ‘wchar’ Wide Character (16-bit)
3.3.10 ‘string’ String (8-bit characters)
3.3.11 ‘wstring’ Wide Character String Array (16-bit characters)
3.3.12 ‘word’ Unsigned (16-bit)
3.3.13 ‘dword’ Unsigned (32-bit)
3.3.14 ‘qword’ Unsigned (64-bit)
3.3.15 ‘handle’ General Handle (32-bit)
3.3.16 ‘void’ Empty Declaration
3.4 Integers Versus Floats
3.4.1 Overview
3.5 Strings Versus Characters
3.6 Dimensional Data
3.6.1 What is Dimensional Data
3.6.2 Allocation
3.6.4 Garbage Collection
3.6.5 Array Examples
3.6.3 Key Names
3.7 Contiguous Data
3.7.1 Binary Data
3.7.2 Contiguous Memory
3.7.3 Scattered Data
3.8 Predefined Data
3.8.1 Overview
3.8.2 SDK Definitions
3.9 Literal Numeric Data
3.9.1 Types
3.10 Literal String Data
3.10.1 Types
3.10.2 String Constants
3.10.3 Line Endings
3.11 Operators
3.11.1 Overview
3.11.2 Boolean in Expressions
3.11.3 Operator Types
3.11.4 Data Types
3.12 Operator Precedence
3.12.1 What Happens First
3.12.2 A Note About Interpreted Versus Compiled
3.13 Assignment
3.13.1 Setting a Variable
3.13.2 Assignment Types
3.14 Math Operators
3.15 Bitwise Math Operators
3.16 Boolean Logical Operators
3.17 Comparison Operators
3.18 Unary Operators
3.18.1 The ‘++’ and ‘--’ Operators
3.18.2 The ‘~’, ‘!’ and ‘-’ Operators
3.19 Type Matching
3.19.1 Overview
3.19.2 Mixing Strings and Numeric Types
3.20 Handles
3.20.1 Introduction to Handles
3.20.2 External Handles
3.21 Handle Functions
3.21.1 Overview
3.21.2 Window Handles
3.21.3 Generic Functions
CloseHandle Function
EnumerateHandles Function
GetHandleCount Function
GetHandleType Function
GetName Function
MakeHandle Function
IsValidHandle Function
3.22 Variable Functions
3.22.1 Overview
3.22.2 Key Names
3.22.3 Binary Data
3.22.4 Cluster Data
3.22.5 Working Pool
3.22.6 Functions
ArrayAddKeyName Function
ArrayAddKeyNames Function
ArrayClear Function
ArrayFindKeyName Function
ArrayGetAxisDepth Function
ArrayGetAxisSize Function
ArrayGetKeyName Function
ArrayGetKeys Function
ArrayHasKeyName Function
ArrayIsKeyName Function
ArrayIsValidKeyName Function
ArrayToCluster Function
ClusterToArray Function
GetVariablePointer Function
GetVariableSize Function
GetWorkingPoolSize Function
IsNullString Function
ReleaseWorkingPoolSpace Function
Chapter Four — Flow Control
4.1 Introduction to Program Flow Control
4.1.1 Overview
4.1.2 Statement Keywords Versus Functions
4.1.3 The Script Engine
4.2 Statements and Blocks
4.2.1 Overview
4.2.2 The Statement
4.2.3 Blocks
4.2.4 Functions
4.2.5 Programs
4.3 Entry Point
4.3.1 Overview
4.3.2 How Does a Script Start
4.3.3 How Entry Points Are Used
4.3.4 Reentrant Scripts
4.3.5 Unexecutable Code
4.4 Loops
4.4.1 Overview
4.4.2 Exiting Loops
4.4.3 The ‘break’ Keyword
4.4.4 The ‘continue’ Keyword
4.5 The ‘while’ Loop
4.5.1 Overview
4.5.2 Syntax and Structure
4.6 The ‘for’ Loop
4.6.1 Overview
4.6.2 Syntax and Structure
4.7 Conditionals
4.8 ‘if’, ‘elseif’ and ‘else’ Statements
4.8.1 The If Condition
4.8.2 Syntax and Structure
4.9 The ‘switch’ Statement
4.9.1 Overview
4.9.2 Syntax and Structure
4.9.3 Limitations and Remarks
4.10 Script Functions
4.10.1 Overview
4.10.2 Prototypes
4.10.3 Passing Parameters
4.10.4 Returning Values
4.11 The ‘return’ Statement
4.12 The ‘exit’ Statement
4.13 Executing External Programs
4.13.1 Overview
4.13.2 Menu Functions
4.13.3 Scripts
4.13.4 Shell
4.13.5 External Program Functions
CreateProcess Function
CreateProcessAsElevated Function
EnumerateScripts Function
GetProcessExitCode Function
RunBackgroundScript Function
RunScript Function
RunProgram Function
RunProgramElevated Function
WaitForObject Function
4.14 Control and Background Processes
4.14.1 Overview
4.14.2 Limitations
4.14.3 Running Scripts in Background
4.14.4 Functions
GetScriptDefaultLog Function
GetScriptErrorLog Function
GetScriptHandle Function
GetScriptProperties Function
GetThreadHandle Function
IsScriptInBackground Function
IsThreadRunning Function
4.15 Session Data
4.15.1 Overview
4.15.2 Identifying Session Data
4.15.3 Limitations and Notes
4.15.4 Background Scripts
4.15.5 Functions
DecrementSessionValue Function
DeleteSessionValue Function
EnumerateSessionData Function
GetSessionInteger Function
GetSessionPoolSize Function
GetSessionString Function
GetSessionWord Function
IncrementSessionValue Function
ResetSessionData Function
SetSessionValue Function
TestAndSetSessionValue Function
4.16 Directives
4.16.1 What Are Directives
4.16.2 The #include Directive
4.16.3 The #define Directive
4.16.4 Default Definitions
4.16.5 The #ifdef Directive
4.16.6 The #ifndef Directive
4.16.7 The #elseif Directive
4.16.8 The #elif Directive
4.16.9 The #endif Directive
4.16.10 The #resource Directive
4.16.11 The #endresource Directive
4.16.12 The #pragma Directive
4.17 Comments
Chapter Five — General Functions
5.1 General Functions
5.1.1 Overview
5.1.2 Function Groups
5.2 String Functions
5.2.1 Overview
5.2.2 Strings
5.2.2.1 Formatted Strings
5.2.3 String and String Related Functions
5.3 String Tester Functions
5.3.1 Overview
5.3.2 Functions
CompareStrings Function
CompareStringsNoCase Function
HasNumeric Function
HasOrdinalSuffix Function
HasText Function
IsAccounting Function
IsAllLower Function
IsAllUpper Function
IsAlpha8859 Function
IsAlphaNumeric8859 Function
IsAlphaNumeric Function
IsAlpha Function
IsANSI Function
IsANSICharacters Function
IsANSISpace Function
IsASCII Function
IsASCIICharacters Function
IsCurrency Function
IsCurrencyFormatted Function
IsCurrencyPrefix Function
IsCurrencyProper Function
IsDigit Function
IsDrawing Function
IsEmptyString Function
IsExpressionBoolean Function
IsExpressionCharacter Function
IsExpressionGroup Function
IsExpressionLogic Function
IsExpressionMath Function
IsExtendedAlpha Function
IsFalse Function
IsFinancial Function
IsFootnoteReference Function
IsHex Function
IsHTML Function
IsInString Function
IsLeaderBackFill Function
IsLeaderFill Function
IsLower Function
IsNil Function
IsNonBreakingSpace Function
IsNonBreakingSpaceEntity Function
IsNonBreakingSpacePCDATA Function
IsNumeric Function
IsPCDATARequired Function
IsPercentage Function
IsReal Function
IsRealStrict Function
IsRegexMatch Function
IsRoman Function
IsSectionNumber Function
IsSentenceDelimiter Function
IsSGMLCharacterEntity Function
IsSGMLEmptyElement Function
IsSGMLTag Function
IsStringPadded Function
IsTabbedString Function
IsText Function
IsTrue Function
IsUnicode Function
IsUpper Function
IsValidSGMLAttribute Function
IsValidSGMLCharacter Function
IsValidSGMLElement Function
IsValidSGMLStartCharacter Function
IsValidVariableCharacter Function
IsVowel Function
IsWildListMatch Function
IsWildMatch Function
IsWildString Function
IsWordDelimiter Function
IsWordSpace Function
5.4 Basic String Functions
5.4.1 Overview
5.4.2 Functions
ANSITextToXML Function
AppendWithDelimiter Function
ChangeCase Function
CharacterEntityToValue Function
CharacterToLowerCase Function
CharacterToUpperCase Function
ConformAddressString Function
ConvertAddNewlines Function
ConvertDeleteNewlines Function
ConvertFromEscapeCharacters Function
ConvertFromUnderbars Function
ConvertFromUnderlines Function
ConvertNoCodes Function
ConvertNoPunctuation Function
ConvertNoSpaces Function
ConvertSoftBreaksToSpaces Function
ConvertToEscapeCharacters Function
ConvertToSingleSpaces Function
ConvertToUnderbars Function
ConvertToUnderlines Function
ConvertWordSpaces Function
DeleteStringSegment Function
FindInString Function
GetListItemType Function
GetNthWord Function
GetNumericType Function
GetParameter Function
GetParameterName Function
GetParameterValue Function
GetParameterEqualName Function
GetParameterEqualValue Function
GetQNameParts Function
GetStringLength Function
GetStringFromQuotes Function
GetStringSegment Function
GetTagAttributes Function
GetTagElement Function
GetTagTextContent Function
GetTrimmedStringLength Function
GetWordCount Function
GetWordType Function
InsertStringSegment Function
InString Function
LayerStringSegment Function
MakeLowerCase Function
MakeUpperCase Function
OrderProperName Function
PadString Function
QuotedStringToString Function
ReplaceInString Function
ReplaceInStringRegex Function
ReplaceStringSegment Function
ReverseString Function
ScanString Function
SkipBackWordSpaces Function
SkipToLineEnding Function
SkipToNonText Function
SkipToWordSpace Function
SkipWordSpaces Function
SplitProperName Function
StringToQuotedString Function
StripOrdinalSuffix Function
TrailStringAfter Function
TrailStringAfterAlways Function
TrailStringBefore Function
TrimNonBreakingSpaces Function
TrimPadding Function
TrimPaddingEntities Function
TrimString Function
ValueToCharacterEntity Function
WordsToArray Function
XMLTextToANSI Function
XMLTextToUTF Function
5.5 Speciality String Functions
5.5.1 Overview
5.5.2 Functions
CreateSortImage Function
FormatString Function
GetLeaderFillPosition Function
WordToPlural Function
WordToSingular Function
5.6 Numeric String Processing
5.6.1 Overview
5.6.2 Functions
AlphaToInteger Function
CellAddressGetColumn Function
CellAddressGetRow Function
CellAddressToIndex Function
CellIndexToAddress Function
CardinalToInteger Function
DecimalToFloat Function
DecimalToInteger Function
FloatToString Function
FormatNumberWithComma Function
FormattedMoneyToNumber Function
GetNumericDecimalPortion Function
GetNumericWholePortion Function
HexBufferToBlock Function
HexBufferToByteString Function
HexBufferToString Function
HexToBuffer Function
HexToInteger Function
IntegerToAlpha Function
IntegerToCardinal Function
IntegerToOrdinal Function
IntegerToRoman Function
IntegerToBinaryCombo Function
IntegerToBinaryUnits Function
MoneyRemoveTrailingZeros Function
OctalToInteger Function
RomanToInteger Function
TextToInteger Function
5.7 Tabs and Tab Characters
5.7.1 Overview
5.7.2 Tab Functions
CollapseTabs Function
ExpandTabs Function
NativeToRealized Function
RealizedToNative Function
Tabify Function
5.8 Word Parsing
5.8.1 Overview
5.8.2 Basic Operation
5.8.3 Setting Up a Parse Operation
5.8.4 Word Parse Functions
WordParseCreate Function
WordParseGetEndX Function
WordParseGetPosition Function
WordParseGetResult Function
WordParseGetSpace Function
WordParseGetSpaceSize Function
WordParseGetStartX Function
WordParseGetWord Function
WordParseHasSpace Function
WordParseSetData Function
WordParseSetPosition Function
5.9 String Pool Functions
5.9.1 Overview
5.9.2 When to Use an SPO
5.9.3 Pool Operation
5.9.4 Functions
PoolAppend Function
PoolAppendAsPCData Function
PoolAppendAsXString Function
PoolAppendFile Function
PoolAppendFormattedString Function
PoolAppendNewLine Function
PoolCreate Function
PoolGetPool Function
PoolGetPosition Function
PoolGetReadPosition Function
PoolGetString Function
PoolOverlay Function
PoolPut Function
PoolReset Function
PoolSetNewLineMode Function
PoolSetPosition Function
PoolWriteFile Function
5.10 Data Object Functions
5.10.1 Overview
5.10.2 Object Descriptors
5.10.3 Functions
DataObjectCreate Function
DataObjectGetAllocation Function
DataObjectDeleteSection Function
DataObjectGetDescriptor Function
DataObjectGetSize Function
DataObjectInsertSection Function
DataObjectLoadFile Function
DataObjectSetDescriptor Function
DataObjectSetSize Function
DataObjectWriteFile Function
5.11 Object Meta Data
5.11.1 Overview
5.11.2 Functions
GetObjectMetaData Function
SetObjectMetaData Function
5.12 Date and Time Functions
5.12.1 Overview
5.12.2 File Times and File Systems
5.12.3 Comparing Times and Dates
5.12.4 Formatting Codes
5.12.5 Locale
5.12.6 Functions
AddDays Function
AddDuration Function
DateToUnix Function
DurationToComponents Function
DurationToDays Function
DurationToString Function
DurationToTimeComponents Function
EnumerateTimeZones Function
FormatDate Function
GetDateTimeComponents Function
GetDayOfWeek Function
GetLocalTime Function
GetLocalTimeForZone Function
GetTimeZoneBias Function
GetTimeZoneInformation Function
GetTimeZoneOverride Function
GetUTCTime Function
IsDaylightSavingsTime Function
LocalToUTC Function
SecondsToTime Function
StringToDate Function
StringToDuration Function
StringToTimeZone Function
StringToTimeZoneBias Function
SubtractDates Function
SubtractDays Function
SubtractDuration Function
UnixToDate Function
UTCToLocal Function
5.13 Logs and Log Functions
5.13.1 Overview
5.13.2 Log Objects
5.13.3 Meta Data
5.13.4 Global Log Object
5.13.5 Log Functions
AddMessage Function
ClearGlobalLog Function
GetDefaultLog Function
GetGlobalLog Function
LogAddErrorSummary Function
LogAppendLog Function
LogAppendString Function
LogClearProperties Function
LogCreate Function
LogDisplay Function
LogExport Function
LogGetMessage Function
LogGetMessageCount Function
LogGetMessageProperties Function
LogGetMessageType Function
LogImport Function
LogIndent Function
LogOutdent Function
LogReset Function
LogSetFileType Function
LogSetMessageType Function
LogSetPosition Function
LogSetProperty Function
LogSetTarget Function
LogSetWindow Function
LogToHTML Function
LogToTable Function
LogToText Function
5.14 Message Boxes
5.14.1 Overview
5.14.2 Message Box Function Syntax/Parameters
5.14.3 Console Operation
5.14.4 Message Box Functions
5.14.5 Other Functions
AdminYesNoBox Function
MessageBeep Function
MessageBox Function
OkCancelBox Function
SetMessageBoxDetail Function
UseMessageBoxes Function
YesNoBox Function
YesNoCancelBox Function
YesNoRememberBox Function
YesNoCancelRememberBox Function
5.15 Password Boxes
5.15.1 Overview
5.15.2 Functions
PasswordBox Function
PasswordChangeBox Function
PasswordRememberBox Function
PasswordUsernameBox Function
5.16 Script Timing and Control
5.16.1 Overview
5.16.2 Processing Time
5.16.3 Functions
GetElapsedTime Function
GetLastActivityTick Function
GetTickCount Function
ResetElapsedTime Function
Sleep Function
Yield Function
5.17 Progress Display
5.17.1 Overview
5.17.2 Progress Operation
5.17.3 Progress Options
5.17.4 Progress Functions
AttachApplicationProgress Function
IsApplicationProgressOpen Function
IsProgressOpen Function
ProgressClose Function
ProgressDisableCancel Function
ProgressOpen Function
ProgressSetCaption Function
ProgressSetPhase Function
ProgressSetPhaseCount Function
ProgressSetStatus Function
ProgressUpdate Function
5.18 Hash Functions
5.18.1 Overview
5.18.2 Basic Functions
5.18.3 MD5 Functions
HashString Function
MD5CreateDigest Function
MD5NewDigestObject Function
MD5AddToDigest Function
MD5FinishDigest Function
5.19 Encryption Functions
5.19.1 Overview
5.19.2 Functions
EncryptSettingsString Function
EncryptAsAES Function
DecryptAsAES Function
EncryptAsRC4 Function
GenerateTOTP Function
5.20 Error Processing and Codes
5.20.1 Overview 
5.20.2 Integer Return Values
5.20.3 String and Array Return Values
5.20.4 Handle Return Values 
5.20.5 Formatted Error Code Structure 
5.20.6 Get Last Error Data
5.20.7 IsError Function
5.20.8 IsCancel Function
5.21 Last Error Functions
5.21.1 GetLastError Function 
5.21.2 GetLastErrorMessage Function
5.21.3 Last Log Functions
5.21.4 SetLastError Function
5.21.5 Functions
GetLastDefaultLog Function
GetLastError Function
GetLastErrorLog Function
GetLastErrorMessage Function
SetLastError Function
IsCancel Function
IsError Function
IsNotError Function
5.22 Byte and Word Functions
5.22.1 Overview 
5.22.2 Get/Put Word Functions
Get8Word Function
Get16Word Function
Get32Word Function
Get64Word Function
Get32Float Function
Get64Float Function
Put8Word Function
Put16Word Function
Put32Word Function
Put64Word Function
Put32Float Function
Put64Float Function
Get8String Function
Get16String Function
PutString Function
5.22.3 Binary Word Functions
GetLowByte Function
GetHighByte Function
GetLowWord Function
GetHighWord Function
Make32Word Function
Make64Word Function
Swap16Word Function
Swap32Word Function
Swap64Word Function
5.22.4 Binary Memory Functions
BinaryCompare Function
BinaryCompareNoCase Function
BinaryCopySegment Function
BinaryPutSegment Function
BinaryReadRecord Function
BinaryScan Function
BinaryWriteRecord Function
5.22.5 Color Functions
ApplyTintToColor Function
ApplyTintToRGB Function
ColorToRGB Function
GetRedValue Function
GetGreenValue Function
GetBlueValue Function
IsDefaultColor Function
MakeRGBColor Function
RGBToColor Function
5.23 Encoding Functions
5.23.1 Overview 
5.23.2 Base32 Encoding
5.23.3 Base64 Encoding
5.23.4 Run Length Encoding
5.23.5 Functions
DecodeString Function
EncodeString Function
RunLengthDecode Function
RunLengthEncode Function
5.24 Unicode Functions
5.24.1 Overview 
5.24.2 Functions
AnsiToUnicode Function
AnsiToUTF Function
CheckUTFCompliance Function
EntitiesToUTF Function
UnicodeToAnsi Function
UnicodeToUTF Function
UTFToAnsi Function
UTFToEntities Function
UTFToUnicode Function
5.25 Special Functions
5.25.1 Overview 
5.25.2 Functions
CommandLineToTable Function
ExitApplication Function
ForceScriptError Function
IsDesktopRunning Function
IsDialogOpen Function
GetApplicationCode Function
GetApplicationName Function
GetApplicationParameter Function
GetApplicationStartTick Function
GetApplicationStartTime Function
GetApplicationVersion Function
GetCommandLine Function
GetScriptDescription Function
GetScriptEngineVersion Function
GetScriptFilename Function
GetScriptFolder Function
GetScriptFunction Function
GetScriptLine Function
GetScriptMapLine Function
GetScriptMapFilename Function
GetScriptName Function
GetScriptParent Function
GetScriptStackLevel Function
GetScriptStartTime Function
GetScriptsExtensionFolder Function
GetScriptsFolder Function
GetScriptsUserFolder Function
GetUnwindFunction Function
SetApplicationName Function
SetApplicationParameter Function
SetApplicationVendorURI Function
SetScriptDescription Function
SetScriptName Function
SetUnwindFunction Function
Chapter Six — File Functions
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
GetCaretXPosition Function
GetCaretYPosition Function
GetEditObjectChangeCount Function
GetEditObjectElapsedTime Function
GetEditObjectFilename Function
GetEditObjectFileType Function
GetEditObjectName Function
GetEditObjectType Function
GetEditObjectWindow Function
GetLastXPosition Function
GetLastYPosition Function
GetSelectClue Function
GetSelectCount Function
GetSelectEndXPosition Function
GetSelectEndYPosition Function
GetSelectMode Function
GetSelectStartXPosition Function
GetSelectStartYPosition Function
SetCaretPosition Function
SetSelectArea Function
SetSelectClue Function
SetSelectMode Function
UpdateEditWindow Function
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
Chapter Seven — Math Functions
7.1 General Math Operations
7.1.1 Overview
7.1.2 Functions
Absolute Function
Ceiling Function
Exponential Function
Floor Function
IsFinite Function
IsNaN Function
Log Function
Max Function
Min Function
NaN Function
Pi Function
Power Function
Random Function
Round Function
SeedRandom Function
Sign Function
SquareRoot Function
7.2 Trigonometric Functions
7.2.1 Overview
7.2.2 Functions
ArcCosine Function
ArcSine Function
ArcTangent Function
Cosine Function
DegreesToRadians Function
HyperbolicCosine Function
HyperbolicSine Function
HyperbolicTangent Function
Hypotenuse Function
RadiansToDegrees Function
SetAngleMode Function
Sine Function
Tangent Function
Chapter Eight — Data Functions
8.1 Introduction to Data Support
8.1.1 Overview
8.1.2 CSV Data
8.1.3 Text Tools
8.1.4 Array Tools
8.1.5 ODBC/SQL
8.1.6 Data Sheet
8.2 Comma Separated Values
8.2.1 Overview
8.2.2 The CSV Object
8.2.3 Functions
CSVAppendField Function
CSVArrayToString Function
CSVCreate Function
CSVGetFieldCount Function
CSVGetFields Function
CSVGetNumericField Function
CSVGetStringField Function
CSVIsLastField Function
CSVIsLastRecord Function
CSVReadTable Function
CSVReset Function
CSVSetExportFlags Function
CSVSetRecord Function
CSVTableToString Function
CSVWriteRecord Function
CSVWriteTable Function
8.3 Text Data Tools
8.3.1 Overview
8.3.2 Functions
FormattedTextToArray Function
8.4 Array Data Tools
8.4.1 Overview
8.4.2 Functions
ArrayToParameters Function
BinarySearchList Function
BinarySearchTable Function
DeleteEmptyTableRows Function
DeleteListItem Function
DeleteTableRow Function
ExplodeString Function
ImplodeArray Function
FindInList Function
FindInTable Function
HasData Function
HasColumnData Function
HasRowData Function
HasTableData Function
InsertListItem Function
InsertTableRow Function
IsEmpty Function
IsListEmpty Function
IsColumnEmpty Function
IsRowEmpty Function
IsTableEmpty Function
ListDifference Function
ListIntersection Function
ListIsSubset Function
ListUnion Function
ParametersToArray Function
ParametersToTable Function
SortList Function
SortTable Function
TableDeleteDuplicates Function
TableToParameters Function
TableToText Function
8.5 Open Database Connectivity (ODBC) Tools
8.5.1 Overview
8.5.2 Using ODBC
8.5.3 ODBC Objects
8.5.4 Data Types
8.5.5 ODBC Errors
8.5.6 Functions
ODBCConnect Function
ODBCFetchAll Function
ODBCFetchArray Function
ODBCFetchBinary Function
ODBCFetchColumnName Function
ODBCFetchColumnNames Function
ODBCFetchData Function
ODBCGetColumnCount Function
ODBCGetRowCount Function
ODBCHasData Function
ODBCNextRow Function
ODBCQuery Function
8.6 Data Sheet
8.6.1 Overview
8.6.2 Operation
8.6.3 Rows and Columns
8.6.4 Cells and Cell Data
8.6.5 Cell Style
8.6.6 Edit Management
8.6.7 Data Sheet Object Functions
DataSheetCreate Function
DataSheetEnumerateSheets Function
DataSheetExport Function
DataSheetExportRegion Function
DataSheetGetObject Function
DataSheetGetSheetName Function
DataSheetImport Function
DataSheetOpen Function
DataSheetSetSheetName Function
DataSheetSetSheetSize Function
DataSheetToTable Function
8.6.8 Workbooks
8.6.9 Workbooks Functions
DataSheetAddToWorkbook Function
DataSheetCreateWorkbook Function
DataSheetExportWorkbook Function
8.6.10 Default Units
8.6.11 Measuring Functions
DataSheetGetColumnWidth Function
DataSheetGetDefaultColumnWidth Function
DataSheetGetDefaultRowHeight Function
DataSheetGetRowHeight Function
DataSheetGetSheetDepth Function
DataSheetGetSheetWidth Function
DataSheetMeasureSheet Function
DataSheetSetDefaultColumnWidth Function
DataSheetSetDefaultRowHeight Function
8.6.12 Edit Management Functions
DataSheetActionClose Function
DataSheetActionOpen Function
DataSheetEnableTransactions Function
DataSheetIsActionOpen Function
8.6.13 Style Functions
DataSheetGetCellStyle Function
DataSheetGetDefaultFont Function
DataSheetGetStyle Function
DataSheetGetStyleCount Function
DataSheetGetStyleProps Function
DataSheetSetStyle Function
8.6.14 Row Functions
DataSheetGetRowCount Function
DataSheetGetRowDataWord Function
DataSheetGetRowProps Function
DataSheetHasRowArray Function
DataSheetIsRowDisabled Function
DataSheetIsRowEmpty Function
DataSheetIsRowHidden Function
DataSheetRowDelete Function
DataSheetRowInsert Function
DataSheetSetRowDataWord Function
DataSheetSetRowHeight Function
8.6.15 Column Functions
DataSheetColumnDelete Function
DataSheetColumnInsert Function
DataSheetGetColumnCount Function
DataSheetGetColumnProps Function
DataSheetHasColumnArray Function
DataSheetIsColumnDisabled Function
DataSheetIsColumnHidden Function
DataSheetSetColumnWidth Function
8.6.16 Cell Functions
DataSheetEnumerateNamedCells Function
DataSheetFindCellByName Function
DataSheetGetCell Function
DataSheetGetCellAttributes Function
DataSheetGetCellAttributeString Function
DataSheetGetCellName Function
DataSheetGetCellText Function
DataSheetGetCellType Function
DataSheetGetColumnSpan Function
DataSheetIsCellDisabled Function
DataSheetIsCellHidden Function
DataSheetIsCellMerged Function
DataSheetIsCellNull Function
DataSheetIsCellProtected Function
DataSheetIsCellReadOnly Function
DataSheetMergeCells Function
DataSheetSetCellAttributes Function
DataSheetSetCellDisabled Function
DataSheetSetCellHidden Function
DataSheetSetCellProtected Function
DataSheetSetCellReadOnly Function
DataSheetSetCellStyle Function
DataSheetSetCellText Function
DataSheetSetCellTextWrap Function
DataSheetSetCellType Function
8.7 JavaScript Object Notation (JSON)
8.7.1 Overview
8.7.2 Item Name
8.7.3 Functions
JSONLoad Function
JSONGetInteger Function
JSONGetString Function
JSONGetType Function
JSONGetValue Function
Chapter Nine — Dialog Functions
9.1 Dialogs
9.1.1 Introduction
9.1.2 Resources
9.2 Common Dialogs
9.2.1 Introduction
9.2.2 Message Box Functions
9.2.3 Password Functions
9.2.4 Browse Function Overview
9.2.5 Filters
9.2.6 Path Scoping
9.2.7 Path Substitution
9.2.8 File Browse Functions
BrowseAddOpenScope Function
BrowseAddSaveScope Function
BrowseFolder Function
BrowseIsInOpenScope Function
BrowseIsInSaveScope Function
BrowseOpenFile Function
BrowseOpenFiles Function
BrowseSaveFile Function
9.3 Custom Dialogs
9.3.1 Dialog Components
9.3.2 Dialog Box Basics
9.3.3 Dialog Style
9.3.5 Opening a Dialog
9.3.6 Windows Messages
9.4 Dialog Resource Templates
9.4.1 Introduction
9.4.2 An Example
9.4.3 Dialog Resource Structure
9.4.4 Dialog Units and Measurements
9.4.5 Screen Position
9.4.6 Dialog Box Window Menu
9.4.7 Dialog Box Fonts
9.4.8 Controls
9.4.9 Control IDs 
9.4.10 Supported Controls
9.5 The Dialog Resource
9.5.1 Introduction
9.5.2 Resource Structure
9.5.3 Resource Statements
DIALOG Resource Statement
DIALOGEX Resource Statement
BEGIN Resource Statement
CAPTION Resource Statement
CHARACTERISTICS Resource Statement
CLASS Resource Statement
END Resource Statement
EXSTYLE Resource Statement
FONT Resource Statement
LANGUAGE Resource Statement
MENU Resource Statement
STYLE Resource Statement
VERSION Resource Statement
9.6 Dialog Controls and Common Controls
9.6.1 Control Types
9.6.2 Window Styles
9.6.3 Control Class Names
9.6.4 Button Class Styles
9.6.5 ComboBox Class Styles
9.6.6 Edit Class Styles
9.6.7 ListBox Class Styles
9.6.8 Scrollbar Class Styles
9.6.9 Static Class Styles
9.6.10 Trackbar Class Styles
9.7 Dialog Control Resource Statements
9.7.1 Introduction
9.7.2 Resource Statements
AUTO3STATE Resource Statement
AUTOCHECKBOX Resource Statement
AUTORADIOBUTTON Resource Statement
CHECKBOX Resource Statement
COMBOBOX Resource Statement
CONTROL Resource Statement
CTEXT Resource Statement
DEFPUSHBUTTON Resource Statement
EDITTEXT Resource Statement
GROUPBOX Resource Statement
ICON Resource Statement
LISTBOX Resource Statement
LTEXT Resource Statement
PUSHBOX Resource Statement
PUSHBUTTON Resource Statement
RADIOBUTTON Resource Statement
RTEXT Resource Statement
SCROLLBAR Resource Statement
STATE3 Resource Statement
9.8 Image Resources
9.8.1 Introduction
9.8.2 ICON and BITMAP Resource Structure
9.8.3 Functions
LoadBitmap Function
LoadIcon Function
9.9 Dialog Functions
9.9.1 Overview
9.9.2 Dialog Procedures
9.9.3 Default Control Error Codes
9.9.4 Dialog Box Functions
DialogBox Function
DialogGetCaption Function
DialogEnumerateControls Function
DialogGetFrameHeight Function
DialogGetFrameWidth Function
DialogGetFrameXPosition Function
DialogGetFrameYPosition Function
DialogGetPageHandle Function
DialogGetPageHeight Function
DialogGetPageWidth Function
DialogGetPageXPosition Function
DialogGetPageYPosition Function
DialogGetResourceName Function
DialogKillTimer Function
DialogPositionAtMouse Function
DialogPositionCenter Function
DialogPositionLeft Function
DialogPositionRight Function
DialogPostCancel Function
DialogPostOK Function
DialogSetAdHocMenu Function
DialogSetCaption Function
DialogSetHelp Function
DialogSetIcon Function
DialogSetMaximumSize Function
DialogSetMenu Function
DialogSetMinimumSize Function
DialogSetPageColor Function
DialogSetPosition Function
DialogSetReturnValue Function
DialogSetTimer Function
IsDialogPropertySheet Function
9.10 Control Functions
9.10.1 Overview
9.10.2 Functions
ControlChangeColor Function
ControlChangeFont Function
ControlDisable Function
ControlEnable Function
ControlGetHandle Function
ControlGetID Function
ControlGetPosition Function
ControlGetWindowStyle Function
ControlHide Function
ControlHideGroup Function
ControlIsEnabled Function
ControlIsHidden Function
ControlSendMessage Function
ControlSetFocus Function
ControlSetPosition Function
ControlShow Function
ControlShowGroup Function
ControlUpdate Function
GetMessageParameter Function
9.11 Button Controls
9.11.1 Introduction
9.11.2 Button Types and Styles
9.11.3 Check Boxes
9.11.4 Group Boxes
9.11.5 Push Buttons
9.11.6 Radio Buttons
9.11.7 Notifications
9.11.8 Button Functions
ButtonGetText Function
ButtonSetImage Function
ButtonSetText Function
9.12 Checkbox and Radio Controls
9.12.1 Introduction
9.12.2 Checkbox Specific Styles
9.12.3 Radio Button Styles
9.12.4 Notifications
9.12.5 Checkbox/Radio Button Functions
CheckboxGetState Function
CheckboxGetText Function
CheckboxHighlight Function
CheckboxSetImage Function
CheckboxSetState Function
CheckboxSetText Function
9.13 Date/Time Control
9.13.1 Introduction
9.13.2 Control Styles
9.13.3 Notifications
9.13.4 Functions
DateControlGet Function
DateControlSet Function
TimeControlGet Function
TimeControlSet Function
9.14 Edit Controls
9.14.1 Introduction
9.14.2 Edit Controls
9.14.3 Functions
EditGetText Function
EditGetUnicode Function
EditGetUTF Function
EditSetText Function
9.15 Combo Box Controls
9.15.1 Introduction
9.15.2 Combo Box List Box
9.15.3 Current Selection
9.15.4 Drop Down Lists
9.15.5 Combo Box — List Box
9.15.6 Combo Box — Edit Control
9.15.7 Combo Box Notifications and Messages
9.15.8 Combo Box Functions
ComboBoxAddArray Function
ComboBoxAddItem Function
ComboBoxDeleteItem Function
ComboBoxFindItem Function
ComboBoxFindItemExact Function
ComboBoxGetArray Function
ComboBoxGetDropWidth Function
ComboBoxGetEditText Function
ComboBoxGetItemCount Function
ComboBoxGetItemText Function
ComboBoxGetSelectIndex Function
ComboBoxGetSelectString Function
ComboBoxInsertItem Function
ComboBoxLimitEditSize Function
ComboBoxLoadFolder Function
ComboBoxLoadList Function
ComboBoxReset Function
ComboBoxSelectItem Function
ComboBoxSetDropWidth Function
ComboBoxSetEditText Function
ComboBoxShowDropDown Function
9.16 List Box Controls
9.16.1 Introduction
9.16.2 List Box Types and Styles
9.16.3 List Box Notifications
9.16.4 List Box Functions
ListBoxAddArray Function
ListBoxAddItem Function
ListBoxDeleteItem Function
ListBoxFindItem Function
ListBoxGetArray Function
ListBoxGetItemCount Function
ListBoxGetItemText Function
ListBoxGetSelectArray Function
ListBoxGetSelectCount Function
ListBoxGetSelectIndex Function
ListBoxGetSelectList Function
ListBoxInsertItem Function
ListBoxLoadList Function
ListBoxLoadFolder Function
ListBoxReplaceItem Function
ListBoxReset Function
ListBoxSelectItem Function
ListBoxSetCaret Function
ListBoxSetSelectIndex Function
ListBoxSetTabPositions Function
ListBoxTestItemSelect Function
9.17 Data Controls
9.17.1 Introduction
9.17.2 List Box Emulation
9.17.3 Data Control Types and Styles
9.17.4 Data Control Notifications
9.17.5 Data Control Functions
DataControlAddString Function
DataControlAddTable Function
DataControlDeleteColumn Function
DataControlDeleteRow Function
DataControlFindCell Function
DataControlFindRowData Function
DataControlGetCaretPosition Function
DataControlGetCellAttributes Function
DataControlGetCellRect Function
DataControlGetCellSize Function
DataControlGetCellText Function
DataControlGetCellType Function
DataControlGetChangingText Function
DataControlGetClickData Function
DataControlGetClickPosition Function
DataControlGetColumnCount Function
DataControlGetColumnHeadings Function
DataControlGetColumnPositions Function
DataControlGetColumnWidths Function
DataControlGetData Function
DataControlGetDefaultRowHeight Function
DataControlGetRowCount Function
DataControlGetRowData Function
DataControlGetRowSelection Function
DataControlGetRowSelectState Function
DataControlGetSelectCount Function
DataControlGetSelectList Function
DataControlGetSortColumn Function
DataControlGetSortMode Function
DataControlGetString Function
DataControlGetTable Function
DataControlHasColumnArray Function
DataControlHasRowArray Function
DataControlInsertColumn Function
DataControlInsertRow Function
DataControlInsertString Function
DataControlLoadList Function
DataControlMergeCells Function
DataControlRefreshLegends Function
DataControlResetContent Function
DataControlSetActionReturnCode Function
DataControlSetCaretPosition Function
DataControlSetCellAttributes Function
DataControlSetCellHighlight Function
DataControlSetCellState Function
DataControlSetCellStyle Function
DataControlSetCellText Function
DataControlSetCellType Function
DataControlSetColumnFlags Function
DataControlSetColumnHeadings Function
DataControlSetColumnPositions Function
DataControlSetDefaultRowHeight Function
DataControlSetEditStatusString Function
DataControlSetGridMode Function
DataControlSetHighlightMode Function
DataControlSetLegendColor Function
DataControlSetLegendStyle Function
DataControlSetLocalEditMode Function
DataControlSetRowColor Function
DataControlSetRowData Function
DataControlSetRowHeight Function
DataControlSetRowSelection Function
DataControlSetRowSelectState Function
DataControlSetSelectColor Function
DataControlSetSelectMode Function
DataControlSetStatusWindow Function
DataControlSetSortColumn Function
DataControlSwapRows Function
9.18 Hypertext Controls (SysLink Controls)
9.18.1 Introduction
9.18.2 Control Markup
9.18.3 Controls Styles
9.18.4 Functions
HypertextControlGetState Function
HypertextControlGetText Function
HypertextControlSetText Function
9.19 IP Address Control
9.19.1 Introduction
9.19.2 Controls Styles
9.19.3 Functions
IPAddressControlClear Function
IPAddressControlGetAddress Function
IPAddressControlGetState Function
IPAddressControlIsEmpty Function
IPAddressControlSetAddress Function
IPAddressControlSetFocus Function
IPAddressControlSetRange Function
9.20 Page Control
9.20.1 Introduction
9.20.2 Page Control Types and Styles
9.20.3 Page Control Notifications
9.20.4 Page Control Styles
9.20.5 Page View Control Functions
PageControlGetCaret Function
PageControlGetCaretX Function
PageControlGetCaretY Function
PageControlGetNavTarget Function
PageControlGetNavURI Function
PageControlGetSelectArea Function
PageControlGetSelectArray Function
PageControlGetSelectClue Function
PageControlGetSelectMode Function
PageControlGetText Function
PageControlSetOptions Function
PageControlSetText Function
PageControlSetWidth Function
9.21 Progress Control
9.21.1 Introduction
9.21.2 Range and Current Position
9.21.3 Progress Control Types and Styles
9.21.4 Progress Control Functions
ProgressControlSetRange Function
ProgressControlUpdate Function
9.22 Rich Edit Control
9.22.1 Introduction
9.22.2 Rich Edit Control Types and Styles
9.22.3 Rich Edit Notifications
9.22.4 Rich Edit Control Functions
RichEditGetRTF Function
RichEditGetText Function
RichEditSetRTF Function
RichEditSetText Function
9.23 Scrollbar Control
9.23.1 Introduction
9.23.2 Scrollbar Control Types and Styles
9.23.3 Scrollbar Notifications
9.23.4 Scrollbar Control Functions
ScrollbarGetPosition Function
ScrollbarGetTrack Function
ScrollbarSetPageSize Function
ScrollbarSetPosition Function
ScrollbarSetRange Function
9.24 Static Controls
9.24.1 Introduction
9.24.2 Static Controls
9.24.3 Functions
StaticControlGetText Function
StaticControlSetImage Function
StaticControlSetText Function
9.25 Tab Control
9.25.1 Introduction
9.25.2 Tab Control Types and Styles
9.25.3 Tab Control Notifications
9.25.4 Tab Control Functions
TabControlAdd Function
TabControlDelete Function
TabControlDeleteAll Function
TabControlGetCount Function
TabControlGetSelection Function
TabControlInsert Function
TabControlSelect Function
9.26 Trackbar Controls
9.26.1 Introduction
9.26.2 Controls Styles
9.26.3 Functions
TrackbarClearSelect Function
TrackbarClearTicks Function
TrackbarGetBuddy Function
TrackbarGetChannelRect Function
TrackbarGetLineSize Function
TrackbarGetPageSize Function
TrackbarGetRange Function
TrackbarGetSelectRange Function
TrackbarGetSliderPosition Function
TrackbarGetSliderRect Function
TrackbarGetSliderSize Function
TrackbarGetTickCount Function
TrackbarGetTickMarks Function
TrackbarGetTickPosition Function
TrackbarGetTooltipWindow Function
TrackbarSetBuddy Function
TrackbarSetLineSize Function
TrackbarSetPageSize Function
TrackbarSetRange Function
TrackbarSetSliderPosition Function
TrackbarSetSelectRange Function
TrackbarSetSliderSize Function
TrackbarSetTickFrequency Function
TrackbarSetTickMark Function
TrackbarSetTooltip Function
TrackbarSetTooltipPosition Function
Chapter Ten — Graphic and Image Functions
10.1 Introduction to Graphic Functions
10.1.1 General
10.1.2 Types of Objects and Functions
10.2 Image Object Functions
10.2.1 Capabilities
10.2.2 Image Objects
10.2.3 Image Quality and Features
10.2.4 Functions
ImageCreate Function
ImageExport Function
ImageExportBMP Function
ImageExportGIF Function
ImageExportJPEG Function
ImageExportPNG Function
ImageGetColors Function
ImageGetHeight Function
ImageGetWidth Function
ImageLoad Function
ImageResizePercent Function
ImageResizePixels Function
Chapter Eleven — SGML Functions
11.1 Introduction to SGML Support
11.1.1 General
11.1.2 Terminology
11.1.3 Namespace
11.1.4 SGML Object
11.1.5 Special Data Types
11.1.6 PVALUE Data Type
11.1.7 TOKEN Data Type
11.1.8 SGML Classes and Objects
11.2 Code Width
11.2.1 General
11.2.2 Functions
SGMLGetCodeIndent Function
SGMLGetCodeWidth Function
SGMLSetCodeIndent Function
SGMLSetCodeWidth Function
11.3 The SGML Object
11.3.1 General
11.3.2 SGML Element Class
11.3.3 Parsing
11.3.4 SGML Object Functions
SGMLClearAttributes Function
SGMLClearParameters Function
SGMLCreate Function
SGMLGetDTDType Function
SGMLGetEditObject Function
SGMLGetMappedTextObject Function
SGMLResetElement Function
SGMLSetCommentMode Function
SGMLSetHTMLDTD Function
SGMLSetFile Function
SGMLSetHandle Function
SGMLSetString Function
SGMLSetUTFEncoding Function
11.3.5 SGML Parsing Functions
SGMLEnumerateErrors Function
SGMLErrorsToLog Function
SGMLFindClosingElement Function
SGMLFindElement Function
SGMLGetCharacterValue Function
SGMLGetElementString Function
SGMLGetElementToken Function
SGMLGetItemPosition Function
SGMLGetItemPosEX Function
SGMLGetItemPosEY Function
SGMLGetItemPosSX Function
SGMLGetItemPosSY Function
SGMLGetItemResult Function
SGMLGetItemSize Function
SGMLGetItemType Function
SGMLGetNamespaceString Function
SGMLGetNamespaceToken Function
SGMLHasErrors Function
SGMLIsEmptyElement Function
SGMLNextElement Function
SGMLNextItem Function
SGMLNextNonSpaceItem Function
SGMLNormalizeErrors Function
SGMLNormalizeToCSS Function
SGMLPreviousElement Function
SGMLScrubParameters Function
SGMLSetDataRange Function
SGMLSetPosition Function
SGMLGetSegment Function
11.3.6 SGML Writing
SGMLToString Function
SGMLWriteSegment Function
SGMLWriteTag Function
11.3.7 Parameters and Properties
SGMLDeleteParameter Function
SGMLGetEntryCount Function
SGMLGetEntryFlags Function
SGMLGetEntryProperties Function
SGMLGetParameter Function
SGMLGetParameterFlags Function
SGMLGetParameterValue Function
SGMLGetParameters Function
SGMLPullParameter Function
SGMLPullParameterValue Function
SGMLPutParameter Function
SGMLSetParameter Function
SGMLSetElement Function
11.3.8 SGML Values and SGML Math
SGMLAddValues Function
SGMLCharEntityToValue Function
SGMLDivideValue Function
SGMLFloatToValue Function
SGMLIntegerToValue Function
SGMLIsDataAvailable Function
SGMLIsImplied Function
SGMLIsMeasurement Function
SGMLIsMixed Function
SGMLIsWholeUnits Function
SGMLMultiplyValue Function
SGMLNormalizeUnits Function
SGMLPixelsToValue Function
SGMLStringToValue Function
SGMLSubtractValues Function
SGMLTWIPSToValue Function
SGMLValueToData Function
SGMLValueToInteger Function
SGMLValueToPixels Function
SGMLValueToString Function
SGMLValueToTWIPS Function
11.3.9 CSS Functions
CSSClearProperties Function
CSSGetDeclaration Function
CSSGetProperties Function
CSSLayerDeclaration Function
CSSLayerProperties Function
CSSSetDeclaration Function
CSSSetProperties Function
11.3.10 DTD and Schema
DTDCreateObject Function
DTDEnumerateAttributes Function
DTDEnumerateElements Function
DTDEnumerateNamespaces Function
DTDEnumerateProperties Function
DTDGetCSSPropertyCase Function
DTDGetNamespaces Function
DTDGetObject Function
DTDGetProperties Function
DTDGetTagCase Function
DTDParseDocType Function
DTDParseTagCase Function
SGMLAttributeToString Function
SGMLElementToString Function
SGMLPropertyToString Function
SGMLStringToAttribute Function
SGMLStringToElement Function
SGMLStringToProperty Function
11.4 HTML Tables
11.4.1 Overview
11.4.2 Operation
11.4.3 Functions
HTMLTableFindCell Function
HTMLTableGetCell Function
HTMLTableGetCellAsText Function
HTMLTableGetCellClass Function
HTMLTableGetCellProperties Function
HTMLTableGetColumnCount Function
HTMLTableGetColumnProperties Function
HTMLTableGetDiscreteCount Function
HTMLTableGetMapCount Function
HTMLTableGetRowClass Function
HTMLTableGetRowCount Function
HTMLTableGetRowPositions Function
HTMLTableGetRowProperties Function
HTMLTableGetTablePosition Function
HTMLTableGetWidths Function
HTMLTableGetWidthValues Function
HTMLTableMap Function
HTMLTableToString Function
HTMLTableToTable Function
HTMLTableToText Function
HTMLTableWrite Function
11.5 HTML Header Management
11.5.1 Overview
11.5.2 Operation
11.5.3 Functions
HTMLHeaderOpen Function
HTMLHeaderGetComponents Function
HTMLHeaderGetDTDComponents Function
HTMLHeaderHasDTD Function
HTMLHeaderHasHeader Function
HTMLHeaderHasLinkData Function
HTMLHeaderHasMetaData Function
HTMLHeaderHasScriptData Function
HTMLHeaderHasStyleData Function
HTMLHeaderHasTitle Function
HTMLHeaderGetDTDString Function
HTMLMetaGetItem Function
HTMLMetaGetItemCount Function
HTMLHeaderGetTitle Function
11.6 The HTML Outline Object
11.6.1 General
11.6.2 Basic Operation
11.6.3 Functions
OutlineCreateObject Function
OutlineGetItemColumn Function
OutlineGetItemCount Function
OutlineGetItemHTML Function
OutlineGetItemPosEX Function
OutlineGetItemPosEY Function
OutlineGetItemPosSX Function
OutlineGetItemPosSY Function
OutlineGetItemRow Function
OutlineGetItemSpan Function
OutlineGetItemText Function
OutlineGetItemType Function
OutlineGetString Function
OutlineSetFile Function
OutlineSetObject Function
11.7 SGML Code Tools
11.7.1 General
11.7.2 Basic Operation
11.7.3 Functions
SGMLFindText Function
11.8 HTML Context Tools
11.8.1 General
11.8.2 Functions
HTMLContextCreate Function
HTMLContextScan Function
HTMLGetContext Function
HTMLGetNames Function
HTMLGetObjects Function
11.9 HTML Code Tools
11.9.1 General
11.9.2 HTML Element Testers
11.9.3 HTML Code Functions
HTMLIsBlockBasicElement Function
HTMLIsBlockElement Function
HTMLIsBodyContainerElement Function
HTMLIsContainerElement Function
HTMLIsFlowContainerElement Function
HTMLIsFormControlElement Function
HTMLIsHeadElement Function
HTMLIsInlineElement Function
HTMLIsInlineStyleElement Function
HTMLIsListContainer Function
HTMLIsListItem Function
HTMLIsRevisionElement Function
HTMLIsSelfContainedElement Function
HTMLIsTableElement Function
HTMLIsTableFrameElement Function
HTMLIsField Function
HTMLIsFieldBlock Function
HTMLIsFieldInline Function
HTMLConformCode Function
HTMLTidyCode Function
HTMLToXHTML Function
11.10 The HTML Writer Object
11.10.1 General
11.10.2 Basic Operation
11.10.3 HTML Writer Object Functions
HTMLAddSegment Function
HTMLCreateWriterObject Function
HTMLSetNewLineMode Function
HTMLWriterToFile Function
HTMLWriterToString Function
11.10.4 HTML Writer Header Functions
HTMLSetDTD Function
HTMLSetEncoding Function
HTMLAddHead Function
HTMLAddFoot Function
11.10.5 HTML Writer Default Style Functions
HTMLSetBlockClass Function
HTMLSetBlockStyle Function
HTMLSetLinkClass Function
HTMLSetCellClass Function
HTMLSetCellStyle Function
HTMLSetRowClass Function
HTMLSetRowStyle Function
HTMLSetTableClass Function
HTMLSetTableStyle Function
HTMLSetTableSpacing Function
11.10.6 HTML Writer Text Stream Functions
HTMLAddText Function
HTMLAddLinkedText Function
HTMLGetTextMode Function
HTMLSetTextMode Function
11.10.7 HTML Writer Paragraph Functions
HTMLAddPara Function
HTMLBeginPara Function
HTMLCompletePara Function
HTMLParaOpen Function
HTMLParaClose Function
11.10.8 Unmanaged Table Functions
HTMLTableOpen Function
HTMLTableClose Function
HTMLRowOpen Function
HTMLRowClose Function
HTMLCellOpen Function
HTMLCellClose Function
HTMLAddCell Function
11.10.9 Managed Table Functions
HTMLBeginTable Function
HTMLColumnSetWidth Function
HTMLCompleteTable Function
HTMLBeginRow Function
HTMLCompleteRow Function
HTMLBeginCell Function
HTMLCompleteCell Function
11.11 HTML Style
11.11.1 General
11.11.2 SGML Object 
11.11.3 Operation
11.11.4 Functions
HTMLStyleAddAttribute Function
HTMLStyleAddBlock Function
HTMLStyleAddItem Function
HTMLStyleCreate Function
HTMLStyleGetProperties Function
HTMLStyleNormalize Function
HTMLStyleRenderCode Function
HTMLStyleRenderText Function
HTMLStyleReset Function
HTMLStyleSetProperties Function
11.12 HTML/XML Fields
11.12.1 General
11.12.2 Field Structure
11.12.3 Field Names and Tokens
11.12.4 Field Parameters
11.12.5 Functions
FieldCreateObject Function
FieldDeleteParameter Function
FieldFindClosingField Function
FieldFindField Function
FieldFromParameters Function
FieldGetFieldContent Function
FieldGetFieldPosEX Function
FieldGetFieldPosEY Function
FieldGetFieldPosSX Function
FieldGetFieldPosSY Function
FieldGetFieldProperties Function
FieldGetFieldResult Function
FieldGetFieldToken Function
FieldGetParameter Function
FieldGetParameters Function
FieldGetParseString Function
FieldLoadString Function
FieldNextField Function
FieldReset Function
FieldSetParameter Function
FieldTokenToString Function
FieldToParameters Function
FieldToString Function
FieldWrite Function
EnumerateSetFields Function
11.13 Page Break Object
11.13.1 General
11.13.2 The Page-Break Field
11.13.3 Property Key Names
11.13.4 Functions
HTMLPageBreakCreate Function
HTMLPageBreakCreateCode Function
HTMLPageBreakGetCount Function
HTMLPageBreakGetPosition Function
HTMLPageBreakGetProperties Function
HTMLPageBreakEnumerate Function
HTMLPageBreakMap Function
11.14 HTML Tools
11.14.1 General
11.14.2 Functions
HTMLValidate Function
11.15 RSS and Atom News Feed Object
11.15.1 General
11.15.2 Functions
RSSLoadFeed Function
RSSGetItemCount Function
RSSGetItemProperties Function
11.16 Compare HTML Files
11.16.1 General
11.16.2 Functions
CompareHTMLCreateMerged Function
CompareHTMLGetFirstDifference Function
CompareHTMLGetNextDifference Function
CompareHTMLGetDifferenceProperties Function
11.17 Low Level Inline XBRL
11.17.1 Overview
11.17.2 Reading
11.17.3 Writing
11.17.4 Functions
iXBRLAddItem Function‡
iXBRLCommit Function‡
iXBRLCreateObject Function
iXBRLGetIDMap Function
iXBRLGetItemCount Function
iXBRLGetItemProperties Function
iXBRLGetMappedTextObject Function
11.18 Low Level XDX Functions
11.18.1 Overview
11.18.2 Engrams
11.18.4 HTML Embed
11.18.5 Functions
11.19 XDX Support Information 
11.19.1 Engram Types
11.19.2 Engram Properties
XDXCreateCalculationComponent Function
XDXCreateContextComponent Function
XDXCreateDisplayComponent Function
XDXCreateElementComponent Function
XDXCreateGroupingComponent Function
XDXCreatePrecisionComponent Function
XDXCreatePresentationComponent Function
XDXCreateUnitComponent Function
XDXEngramToParameters Function
XDXEngramToProperties Function
XDXGetCalculationProperties Function
XDXGetContextMember Function
XDXGetContextProperties Function
XDXGetDisplayFlags Function
XDXGetDisplayProperties Function
XDXGetElement Function
XDXGetEngram Function
XDXGetEngramCount Function
XDXGetEngramPosition Function
XDXGetEngramType Function
XDXGetGroupingProperties Function
XDXGetPrecisionProperties Function
XDXGetPresentationProperties Function
XDXGetUnitProperties Function
XDXMapArea Function
XDXMapFile Function
XDXPropertiesToEngram Function
11.20 XBRL Model
11.20.1 Overview
11.20.2 XBRL Instances
11.20.3 Taxonomies
11.20.4 Instance and Taxonomy Writing
11.20.5 XBRL Model Function Groups
XBRLCreateObject Function
11.20.6 XBRL Model — Loading Functions
XBRLAddInstance Function
XBRLLoadInstance Function
XBRLImportTaxonomy Function
XBRLLoadTaxonomy Function
XBRLPostProcess Function
11.20.7 XBRL Model — Writing Functions
XBRLExportXMLSegment Function†
11.20.8 XBRL Model Support Functions
XBRLGetBaseTaxonomyType Function
XBRLGetEntryPoint Function
XBRLGetEntryPointNamespace Function
XBRLGetEntryPointPrefix Function
XBRLGetInstanceFormat Function
XBRLGetLinkbaseList Function
XBRLGetNamespaceMap Function
XBRLGetSchemaList Function
XBRLGetSchemaRef Function
XBRLSetOptions Function
XBRLSetSchemaRef Function
XBRLTaxonomyTypeToString Function
XBRLTransformData Function
XBRLValidateByDataType Function
11.20.9 Instance — Facts
XBRLAddFact Function
XBRLGetFact Function
XBRLGetFactCount Function
XBRLGetFacts Function
XBRLGetFactsByConcept Function
XBRLGetFactsByContext Function
XBRLGetFactsByElement Function
XBRLGetFactsByPrefix Function
11.20.10 Instance — Contexts
XBRLAddContext Function
XBRLFindContextAxis Function
XBRLGetContext Function
XBRLGetContextCount Function
XBRLGetContexts Function
XBRLGetContextMember Function
11.20.11 Instance — Units
XBRLAddUnit Function
XBRLGetUnit Function
XBRLGetUnitCount Function
XBRLGetUnits Function
11.20.12 Instance — Footnotes
XBRLGetFootnote Function
XBRLGetFootnoteArcs Function
XBRLGetFootnoteCount Function
XBRLGetFootnoteLocators Function
XBRLGetFootnotes Function
XBRLGetFootnotesForFact Function
11.20.13 Taxonomy — Concepts
XBRLAddConcept Function
XBRLGetConcept Function
XBRLGetConceptByID Function
XBRLGetConceptCount Function
XBRLGetConcepts Function
11.20.14 Taxonomy — Definition Functions
XBRLGetDefinitionArc Function
XBRLGetDefinitionArcs Function
XBRLGetDefinitionLink Function
XBRLGetDefinitionLinkCount Function
XBRLGetDefinitionLinks Function
XBRLGetDefinitionLocator Function
XBRLGetDefinitionLocators Function
11.20.15 Taxonomy — Calculations
XBRLFindCalculationGroup Function
XBRLFindCalculationItem Function
XBRLFindCalculationRole Function
XBRLGetCalculationLinkCount Function
XBRLGetCalculationArc Function
XBRLGetCalculationArcs Function
XBRLGetCalculationItem Function
XBRLGetCalculationItemCount Function
XBRLGetCalculationItems Function
XBRLGetCalculationLinkCount Function
XBRLGetCalculationLink Function
XBRLGetCalculationLinks Function
XBRLGetCalculationLocators Function
XBRLGetCalculationRoles Function
11.20.16 Taxonomy — Data Types
XBRLGetDataType Function
XBRLGetDataTypeCount Function
XBRLGetDataTypes Function
11.20.17 Taxonomy — Labels
XBRLGetLabel Function
XBRLGetLabelArcs Function
XBRLGetLabelCount Function
XBRLGetLabelLinks Function
XBRLGetLabelLocators Function
XBRLGetLabels Function
11.20.18 Taxonomy — Presentations
XBRLGetPresentation Function
XBRLGetPresentationArcs Function
XBRLGetPresentationCount Function
XBRLGetPresentationEntry Function
XBRLGetPresentationEntryCount Function
XBRLGetPresentationLink Function
XBRLGetPresentationLinkCount Function
XBRLGetPresentationLinks Function
XBRLGetPresentationLocators Function
11.20.19 Taxonomy — References
XBRLGetReference Function
XBRLGetReferenceArcs Function
XBRLGetReferenceCount Function
XBRLGetReferenceData Function
XBRLGetReferenceLink Function
XBRLGetReferenceLinkCount Function
XBRLGetReferenceLinks Function
XBRLGetReferenceLocators Function
XBRLGetReferences Function
11.20.20 Role Functions
XBRLGetRole Function
XBRLGetRoleCount Function
XBRLGetRoleList Function
XBRLGetRoleReferenceCount Function
XBRLGetRoleReferences Function
Chapter Twelve — Internet Functions
12.1 Internet Functions
12.1.1 General
12.1.2 Proxy and Firewall
12.1.3 General Support Functions
ArrayToIPv4 Function
IPv4ToArray Function
IPv4ToString Function
StringToIPv4 Function
ResolveHostName Function
12.2 Email
12.2.1 General
12.2.2 SMTP
12.2.3 POP3 and the POP Object
12.2.4 General Functions
12.2.5 SMTP Functions
12.2.6 POP Functions
EmailGetSetup Function
IsEmailSetup Function
IsEmailSMTPSetup Function
EmailSendMessage Function
EmailSetupSMTP Function
POPConnect Function
POPDeleteMessage Function
POPGetMessage Function
POPGetMessageCount Function
POPGetMessageHeader Function
POPGetMessageID Function
POPGetMessageIDList Function
POPGetMessageSizeList Function
12.3 File Transfer Protocol (FTP)
12.3.1 General
12.3.2 Normal Sequence
12.3.3 Extended Errors
12.3.4 FTP Functions
FTPCreateFolder Function
FTPDeleteFile Function
FTPDeleteFolder Function
FTPGetFile Function
FTPGetFileSize Function
FTPOpenConnection Function
FTPGetFirstFile Function
FTPGetNextFile Function
FTPPutFile Function
FTPRenameFile Function
12.4 HyperText Transfer Protocol (HTTP)
12.4.1 General
12.4.2 HTTP Functions
HTTPGetFile Function
HTTPGetString Function
HTTPOpenConnection Function
HTTPPost Function
12.5 Serial Interface
12.5.1 General
12.5.2 Serial Functions
SerialEnumeratePorts Function
SerialGetLinkStatus Function
SerialGetProperties Function
SerialGetRxQueueCount Function
SerialOpen Function
SerialRxCharacter Function
SerialRxLine Function
SerialRxPurge Function
SerialTxBlock Function
SerialTxPurge Function
SerialTxString Function
SerialTxWithDelay Function
Chapter Thirteen — Collaboration Functions
13.1 Introduction to Collaboration Functions
13.1.1 Overview
13.2 Types of Collaboration Objects
13.2.1 Locations and Data Stores
13.2.2 Types of Objects
13.3 Task Functions
13.3.1 Task Overview
13.3.2 Task Data Elements
13.3.3 Function Overview
CreateTask Function
DeleteTask Function
EditTask Function
EditTaskData Function
GetTaskCount Function
GetTaskIDs Function
GetTaskProperties Function
UpdateTask Function
Chapter Fourteen — Project Functions
14.1 Project Overview
14.1.1 Introduction
14.1.2 Project Data
14.1.3 Application Level Project
14.2 Project Functions
14.2.1 Introduction
14.2.2 Functions
GetMyProjectsFolder Function
SetMyProjectsFolder Function
ProjectClose Function
ProjectGetBasePath Function
ProjectGetInfo Function
ProjectGetInfoCount Function
ProjectGetInfoData Function
ProjectGetInfoName Function
ProjectSetInfo Function
ProjectGetModifiedStatus Function
ProjectGetName Function
ProjectOpen Function
14.3 Project Entry Functions
14.3.1 Introduction
14.3.2 Entry Data Items
14.3.3 Members
14.3.4 Functions
ProjectDeleteEntry Function
ProjectFindEntry Function
ProjectGetEntry Function
ProjectGetEntryData Function
ProjectGetEntryCount Function
ProjectGetEntryAsNumber Function
ProjectGetEntryAsString Function
ProjectInsertEntry Function
ProjectSetEntryData Function
14.4 Project Validation Functions
14.4.1 Introduction
14.4.2 Example Validation Hook
14.4.3 Functions
ProjectGetMaxValidators Function
ProjectGetValidator Function
ProjectRegisterValidator Function
Chapter Fifteen — Windows/OS Functions
15.1 Identification and System Functions
15.1.1 Overview
15.1.2 Functions
GetComputerName Function
GetNameForSID Function
GetOperatingSystemName Function
GetOperatingSystemVersion Function
GetSIDForName Function
GetSystemInformation Function
GetSystemMetrics Function
GetUserName Function
IsUserInGroup Function
15.2 Process Functions
15.2.1 Overview
15.2.2 Functions
GetEnvironmentVariables Function
GetOperatingSystemFolder Function
IsProcessAdministrator Function
IsProcessElevated Function
TranslateWindowsError Function
15.3 Window Functions
15.3.1 Overview
15.3.2 About Windows
15.3.3 Functions
FindWindow Function
GetCursorPosition Function
SetCursor Function
SetCursorPosition Function
CloseWindow Function
GetApplicationFrameWindow Function
GetApplicationMDIWindow Function
GetDashboardWindow Function
GetDesktopWindow Function
GetFocus Function
GetInfoViewWindow Function
GetManagementViewWindow Function
GetParentWindow Function
GetProgressWindow Function
GetProjectMDIWindow Function
GetProjectTabWindow Function
GetWindowText Function
IsWindowHandleValid Function
IsWindowIcon Function
IsWindowMaximized Function
IsWindowVisible Function
MinimizeWindow Function
PostMessage Function
SendMessage Function
SetFocus Function
SetWindowText Function
15.4 Keyboard and Mouse Input
15.4.1 Overview
15.4.2 Keyboard Operations
15.4.3 Mouse Operations
15.4.4 Functions
IsKeyPressed Function
15.5 Clipboard Functions
15.5.1 Overview
15.5.2 Clipboard Formats
15.5.3 Clipboard Operations
15.5.4 Functions
ClipboardAttachDialog Function
ClipboardCreate Function
ClipboardGetApplication Function
ClipboardGetCSVData Function
ClipboardGetCSVText Function
ClipboardGetData Function
ClipboardGetDIB Function
ClipboardGetFormatCode Function
ClipboardGetFormatDescription Function
ClipboardGetFormatName Function
ClipboardGetFormatSize Function
ClipboardGetFormats Function
ClipboardGetGIF Function
ClipboardGetHTML Function
ClipboardGetHTMLComponents Function
ClipboardGetJPG Function
ClipboardGetPNG Function
ClipboardGetRTF Function
ClipboardGetText Function
ClipboardGetUnicode Function
ClipboardGetUTF Function
ClipboardIsCSVAvailable Function
ClipboardIsDIBAvailable Function
ClipboardIsFormatAvailable Function
ClipboardIsGIFAvailable Function
ClipboardIsHTMLAvailable Function
ClipboardIsImageAvailable Function
ClipboardIsJPGAvailable Function
ClipboardIsPNGAvailable Function
ClipboardIsRTFAvailable Function
ClipboardIsTextAvailable Function
ClipboardIsUnicodeAvailable Function
ClipboardOpen Function
ClipboardRegisterFormat Function
ClipboardSetCSV Function
ClipboardSetData Function
ClipboardSetDIB Function
ClipboardSetGIF Function
ClipboardSetHTML Function
ClipboardSetJPG Function
ClipboardSetPNG Function
ClipboardSetRTF Function
ClipboardSetText Function
ClipboardSetUnicode Function
ClipboardSetUTF Function
15.6 Basic Font Functions
15.6.1 Overview
15.6.2 Functions
ConformFontName Function
CreateFontSubTable Function
EnumerateSystemFonts Function
IsSymbolFontName Function
15.7 Module Resources
15.7.1 Overview
15.7.2 Functions
ReplaceModuleResource Function
ReplaceModuleIcon Function
15.8 OLE Automation
15.8.1 Overview
15.8.2 OLE Values and Data Types
15.8.3 Functions
OLEGetObject Function
OLEGetProperty Function
OLEIEClose Function
OLEIEGet Function
OLEIEIsBusy Function
OLEIEPost Function
OLEIEPostFile Function
OLEIERead Function
OLEIEShow Function
OLEPutProperty Function
OLERunMethod Function
Chapter Sixteen — Application
16.1 Application Introduction
16.1.1 Scope
16.2 Command Line Operation
16.2.1 Parameter
16.2.2 Script Command Line Arguments
16.3 Command Line Functions
16.3.1 Overview
16.3.2 Command Line Arguments
16.3.3 Command Line Functions
GetCommandLineParameter Function
16.4 Settings Functions
16.4.1 General Settings
16.4.2 Application Preferences
16.4.3 Application Settings
16.4.4 The INI Format
16.4.5 The System Registry
GetSetting Function
PutSetting Function
GetEncryptedSetting Function
PutEncryptedSetting Function
RegistryCreateKey Function
RegistryDeleteKey Function
RegistryDeleteValue Function
RegistryEnumerateKeys Function
RegistryEnumerateNames Function
RegistryGet32Word Function
RegistryGet64Word Function
RegistryGetBlock Function
RegistryGetFloat Function
RegistryGetString Function
RegistryGetType Function
RegistrySetValue Function
GetPreferenceData Function
GetPreferenceFile Function
LoadPreferences Function
ResetPreferences Function
SavePreferences Function
SetPreferences Function
16.5 Frame Functions
16.5.1 The Application Frame
16.5.2 The Status Bar Functions
StatusBarGetMessage Function
StatusBarMessage Function
StatusBarSetMessage Function
StatusBarSetProgress Function
16.6 Executing Menu Functions
16.6.1 Menu/Ribbon Functions
16.6.2 Functions
DisableFileHistory Function
RunMenuFunction Function
GetMenuFunctionLog Function
GetMenuFunctionParameters Function
GetMenuFunctionResponse Function
IsMenuFunctionRepeated Function
SetMenuFunctionParameters Function
SetMenuResponseParameter Function
16.7 Information View
16.7.1 Overview
16.7.2 Functions
InfoViewCloseTab Function
InfoViewGetLogObject Function
Chapter Seventeen — Application Integration Functions
17.1 Application Integration
17.1.1 Overview
17.1.2 Special Folders
17.2 Application Startup
17.2.1 Initialization Process
17.2.2 Creating a Startup Script
17.2.3 Capturing Errors
17.2.4 Frame Initialize
17.2.5 Menu Scripts
AddFrameInitializeFunction Function
17.3 Application Shutdown
17.3.1 Shutdown Process
17.3.2 Creating a Shutdown Script
17.4 Menu Functions
17.4.1 Overview
17.4.2 Function Attributes
17.4.3 Function Overview
MenuAddFunction Function
MenuEnumerateFunctions Function
MenuFindFunctionID Function
MenuFindFunctionIndex Function
MenuGetBitmapName Function
MenuGetDescription Function
MenuGetFunctionCode Function
MenuGetFunctionID Function
MenuGetFunctionProperties Function
MenuGetMenuName Function
MenuGetRibbonName Function
17.5 Popup Menu Functions
17.5.1 Overview
17.5.2 Application Popup Menus
17.5.3 Ad Hoc Popup Menus
17.5.4 Function Overview
MenuReplacePopup Function
MenuTrackAdHocPopup Function
MenuTrackPopup Function
17.6 Menu Hooks
17.6.1 Hook Overview
17.6.2 Initialization and Persistence
17.6.3 Function Overview
17.6.4 Hook Modes
17.6.5 Adjusting Menu Function Parameters
17.6.6 Errors
17.6.7 Functions
MenuDeleteHook Function
MenuEnumerateHooks Function
MenuGetHook Function
MenuIsHooked Function
MenuSetHook Function
17.7 Quick Key Functions
17.7.1 Overview
17.7.2 Functions
QuickKeyEnumerate Function
QuickKeyRegister Function
17.8 Edit Window Functions
17.8.1 Overview
17.8.2 Overview of Windows and Window Handles
17.8.3 The Edit Manager
17.8.4 Function Overview
ActivateEditWindow Function
EnumerateEditFiles Function
EnumerateEditWindows Function
FindEditWindow Function
FindEditWindowByAlias Function
FindEditWindowView Function
GetActiveEditObject Function
GetActiveEditWindow Function
GetEditWindowCount Function
GetEditWindowFilename Function
GetEditWindowHandle Function
GetEditWindowLimit Function
GetEditWindowType Function
GetEditObject Function
GetMappedTextObject Function
EditWindowSetCaret Function
17.9 Application Meta Data
17.9.1 Overview
17.9.2 Functions
GetApplicationMetaData Function
SetApplicationMetaData Function
Chapter Eighteen — DataView Integration
18.1 Data View Interface
18.1.1 Overview
18.1.2 DataView Objects
18.1.3 Addressing Cells
18.1.4 Function Groups
DataViewOpenFile Function
18.2 DataView Object
18.2.1 Handles
18.2.2 Tabs
18.2.3 Functions
DataViewGetObject Function
DataViewGetClassName Function
DataViewGetClassType Function
DataViewGetDataSheet Function
DataViewActivateTab Function
DataViewGetTabCount Function
DataViewGetTabIndex Function
DataViewGetTab Function
DataViewGetTabName Function
DataViewAddEditAction Function
DataViewUndoGetCount Function
DataViewUndoSetState Function
DataViewSetEditFlags Function
18.3 Sheet Functions
18.3.1 Overview
18.3.2 Functions
DataViewGetColumnCount Function
DataViewGetRowCount Function
DataViewPreallocate Function
18.4 Row Functions
18.4.1 Overview
18.4.2 Functions
DataViewCloneRow Function
DataViewDeleteRow Function
DataViewDisableRow Function
DataViewEnableRow Function
DataViewGetRowDataWord Function
DataViewGetRowHeight Function
DataViewGetRowProps Function
DataViewHideRow Function
DataViewInsertRow Function
DataViewIsRowDisabled Function
DataViewIsRowEmpty Function
DataViewIsRowHidden Function
DataViewSetRowDataWord Function
DataViewShowRow Function
18.5 Column Functions
18.5.1 Overview
18.5.2 Functions
DataViewHideColumn Function
DataViewIsColumnEmpty Function
DataViewIsColumnHidden Function
DataViewIsColumnVisible Function
DataViewShowColumn Function
18.6 Cell Position Functions
18.6.1 Overview
18.6.2 Functions
DataViewGetCaret Function
DataViewGetCaretCol Function
DataViewGetCaretRow Function
DataViewGetCellRect Function
DataViewGetSelectClue Function
DataViewGetSelectCount Function
DataViewGetSelectMode Function
DataViewSelectRegion Function
DataViewSetCaret Function
18.7 Cell Access Functions
18.7.1 Overview
18.7.2 Functions
DataViewCellGetByName Function
DataViewCellGetData Function
DataViewCellGetName Function
DataViewCellGetText Function
DataViewCellGetType Function
DataViewCellSetByName Function
DataViewCellSetName Function
DataViewCellSetReadOnly Function
DataViewCellSetText Function
DataViewEnumerateNamedCells Function
DataViewFindCell Function
DataViewFindCellByName Function
DataViewIsMergedCell Function
DataViewIsNullCell Function
DataViewIsProtectedCell Function
DataViewIsReadOnlyCell Function
DataViewIsRegionEmpty Function
18.8 Highlight Functions
18.8.1 Overview
18.8.2 Functions
DataViewCellSetHighlight Function
DataViewSetHighlightMode Function
18.9 Form Functions
18.9.1 Overview
18.9.2 Data Types
18.9.3 Errors
18.9.4 Functions
DataViewGetList Function
DataViewGetListColumns Function
DataViewGetListRows Function
DataViewGetListRow Function
DataViewSetList Function
18.10 Forms View Functions
18.10.1 Overview
18.10.2 Functions
FormsViewNewView Function
FormsViewOpenFile Function
FormsViewSetSaveOptions Function
18.11 Data View Script Events
18.11.1 Overview
18.11.2 Events
on_cell_changed
on_cell_changing
on_click
on_context_menu
on_edit_cell_content
on_edit_cell_text
on_edit_copy
on_edit_cut
on_edit_paste
on_edit_row
on_edit_size_request
on_edit_title_request
on_file_export_popup
on_file_export
on_file_import
on_function
on_launch
on_load
on_menu_init
on_print
on_save
on_update_position
18.12 Forms View Script Events
18.12.1 Overview
18.12.2 Events
on_form_add_entry
on_form_clone_entry
on_form_copy_cell
on_form_copy_row
on_form_copy_table
on_form_delete_all
on_form_delete_entry
on_form_edit_entry
on_form_edit_row
on_form_export_table_csv
on_form_export_table_xml
on_form_move_down
on_form_move_up
on_form_options_popup
on_form_validate
Chapter Nineteen — TextView Integration
19.1 Text View
19.1.1 Overview
19.1.2 Related Functions
19.2 MDI Control
19.2.1 Overview
19.2.2 Functions
TextViewOpenFile Function
Chapter Twenty — PageView Integration
20.1 Page View
20.1.1 Overview
20.1.2 Related Functions
PageViewOpenFile Function
20.2 Page View Hooks
20.2.1 Overview
20.2.2 File New Template
20.3 High-Level CSS Support
20.3.1 Overview
20.3.2 CSS Declaration Editor
20.3.3 Declaration Editing Functions
CSSEditDeclaration Function
CSSEditProperties Function
20.4 Fields
20.4.1 Overview
20.4.2 Field Hooks
Include-Text Field
Chapter Twenty-one — EDGARView Integration
21.1 EDGAR Interface
21.1.1 Overview
21.1.2 EDGAR Functions
21.1.3 EDGAR Views
21.1.4 EDGAR Data Access Class
21.2 EDGAR General
21.2.1 Overview
21.2.2 Compression and EIS Files
21.2.3 EDGAR User Interface Support
CompressEIS Function
DecompressEIS Function
EDGARSelectForm Function
21.3 EDGAR Archive
21.3.1 EDGAR Archive Object
21.3.2 Extended Error Information
21.3.3 Functions
EDGARFetchArchiveList Function
EDGARFetchFileNumberInfo Function
EDGARFetchFilingsByCIK Function
EDGARFetchFilingsByFileNumber Function
EDGARArchiveGetDocDescription Function
EDGARArchiveGetDocFileType Function
EDGARArchiveGetDocName Function
EDGARArchiveGetDocType Function
EDGARArchiveGetDocFile Function
EDGARArchiveGetFileCount Function
EDGARArchiveGetObjectType Function
EDGARArchiveGetOwner Function
EDGARArchiveGetProperty Function
EDGARArchiveOpen Function
21.4 SEC Library Interface
21.4.1 Overview
21.4.2 Functions
EDGARLookupCIK Function
EDGARLookupClass Function
EDGARLookupSeries Function
EDGARGetClassTable Function
21.5 EDGAR Library Interface
21.5.1 Overview
21.5.2 Functions
EDGARGetLibraryFolder Function
EDGARImportLibrary Function
EDGARSetLibraryFolder Function
21.6 EDGAR Validation Interface
21.6.1 Overview
21.6.2 Functions
EDGARValidateDate Function
EDGARValidateFilename Function
EDGARValidateNumber Function
EDGARValidateURL Function
EDGARValidateValue Function
21.7 EDGAR Submission Interface
21.7.1 Overview
21.7.2 Functions
EDGARGetLoginCIK Function
EDGARHasCredentials Function
EDGARSetCredentials Function
EDGARSubmitDelayPrompt Function
21.8 EDGAR Filing and System Interface
21.8.1 Overview
21.8.2 EDGAR Session
21.8.3 EDGAR Next
21.8.4 Functions 
EDGARSessionGetHTTPHandle Function
EDGARSessionGetProperties Function
EDGARSessionOpenSession Function
EDGARNextIsBetaEnabled Function
EDGARNextIsAPISetup Function
EDGARNextAPISubmit Function
EDGARNextMakeAPICall Function
EDGARSetUserCredentials Function
21.9 EDGAR Response Interface
21.9.1 Overview
21.9.2 Functions
EDGARResponseGetAcceptedCode Function
EDGARResponseGetFiledBy Function
EDGARResponseGetFileNumbers Function
EDGARResponseGetIssuer Function
EDGARResponseGetItems Function
EDGARResponseGetMessages Function
EDGARResponseGetOwners Function
EDGARResponseGetRegistrants Function
EDGARResponseGetSeries Function
EDGARResponseGetSubjectCompanies Function
EDGARResponseIsAccepted Function
EDGARResponseLoadFile Function
EDGARResponseLoadString Function
EDGARResponseProps Function
EDGARResponseToHTML Function
21.10 EDGARView Interface
21.10.1 Overview
21.11 Form 13F View Interface
21.11.1 Overview
21.11.2 Information Table
21.12 EDGAR Data Access Class (EDAC)
21.12.1 Overview
21.12.2 Supported Modules
21.12.3 Data Types
21.12.4 Named Field
21.12.5 Extended Error Codes
21.12.6 Functions
EDACCreateObject Function
EDACGetItem Function
EDACOpenFile Function
EDACOpenView Function
EDACSaveFile Function
EDACSetItem Function
Chapter Twenty-two — Conversion Functions
22.1 Conversion Interface
22.1.1 Overview
22.1.2 Conversion Options and Parameters
22.1.3 Functions
ConvertCFFtoOTF Function
ConvertFile Function
TranslateAddHook Function
TranslateGetPostProcessHook Function
TranslateGetPreProcessHook Function
TranslateSetPostProcessHook Function
TranslateSetPreProcessHook Function
Chapter Twenty-three — XBRL Functions
23.1 High Level XBRL Interface
23.1.1 Overview
23.2 XBRL View and Objects
23.2.1 Overview
23.2.2 XBRL View and Data View
23.2.3 Functions
XBRLViewGetObject Function
23.3 Presentation Functions
23.3.1 Overview
23.3.2 Functions
XBRLViewGetPresentationContexts Function
XBRLViewGetPresentationCount Function
XBRLViewGetPresentationElements Function
XBRLViewGetPresentationProperties Function
XBRLViewGetPresentationType Function
XBRLViewGetPresentations Function
23.4 XBRL Context Functions
23.4.1 Overview
23.4.2 Functions
XBRLViewGetContextCount Function
XBRLViewGetContext Function
XBRLViewGetContexts Function
XBRLViewGetContextsByElement Function
XBRLViewGetPrimaryContext Function
23.5 Element Functions
23.5.1 Overview
23.5.2 Functions
XBRLViewGetElements Function
XBRLViewGetElementsByContext Function
23.6 Fact and Data Functions
23.6.1 Overview
23.6.2 Functions
XBRLViewGetFact Function
XBRLViewGetFactsByElement Function
XBRLViewGetFactsByContext Function
23.7 Line Item Functions
23.7.1 Overview
23.7.2 Labels
23.7.3 Properties
23.7.4 Functions
XBRLViewGetLineItemCount Function
XBRLViewGetLineItemLabel Function
XBRLViewGetLineItemLabels Function
23.8 XBRL Support Functions
23.8.1 Overview
23.8.2 Functions
XBRLAddFactValues Function
XBRLApplyPrecision Function
XBRLCompareFactValues Function
23.9 High Level XBRL Support
23.9.1 Overview
23.9.2 Functions
XBRLLibraryBrowse Function
23.10 Inline XBRL
23.10.1 Overview
23.10.2 Reading
23.10.3 Writing
23.10.4 Low Level Functions
23.10.5 High Level Functions
iXBRLValidate Function
23.11 XBRL Data Exchange (XDX)
23.11.1 Overview
23.11.2 Functions
XDXCreateTransactionLog Function
XDXValidateXBRL Function
XBRLViewOpenTransactionLog Function
Appendix A — Legato SDK Standard Definitions
Appendix B — XML Data Sheet Format Specification
Appendix C — Menu Function Parameters
Appendix D — Application Menu Guide
Appendix E — Application Parameter Names
Appendix F — Project Technical Information
Appendix G — XDX Transaction Log Specification
Glossary of Common Terms

 

 

GoFiler Legato Script Reference — Generated on 04/22/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.