Technical Reference Manual - InduSoft

Appendix: Built-in Scripting Language
Value
Description
3 Appends to an existing Unicode file with the given file name. If the file doesn't exist, then a new file is created.
This is an optional parameter. If any value other than 0 through 3 is given, or if the parameter is
not used, then 0 is the default.
Returned value
0 Successful execution.
−1
−2
Invalid parameter(s).
Failed to open file. Disk is write protected or file name is invalid.
Examples
Tag Name
Expression
Tag FileWrite( "c: est.txt", "This is a test" )
Tag FileWrite( strFileName, strWriteText )
Tag FileWrite( strFileName, strWriteText, 1 )
FindFile
FindFile is a built-in scripting function that searches for all files that match a given search string.
Function Group Execution Windows Embedded Thin Client
FindFile File Synchronous Supported Supported Supported
Syntax
FindFile(strFile{ | ,"optTagFilesFound"{ | ,optNumTimeout } })
strFile
The name of the file(s) to search for.
You may use wildcards (*) to find multiple files. For example, *.gif to find all GIF files or
log*.txt to find all log files in a sequence (e.g., log001.txt, log002.txt, log003.txt).
By default, the function only searches the project folder, but you may specify a file path (either
relative or absolute) to search elsewhere. For example, if strFile is defined as…
\\volume name or IP address\Logs\log*.txt
…then the function will search the Logs directory on the specified network volume.
optTagFilesFound
An array (of String type) that will receive the names of the matching files. The array name must
be enclosed in quotes; if it is not, then the function will try to get the contents of the array.
This is an optional parameter. If no value is specified, then the file names will not be saved and
the function will only return the number of files found. For more information, see "Returned
value" below.
optNumTimeout
Note: The array will receive only the file names and not their paths, even if you
define strFile to search outside the default directory.
The timeout period (in milliseconds) for the function to be successfully executed.
Page 632
InduSoft Web Studio