VBScript Reference Manual for InduSoft Web Studio

InduSoft Web Studio VBScript Reference Manual
Folder Object
The Folder Object allows the programmer refer to a specific folder. Once the Folder object is
instantiated, it can be referred to as an object from VBScript and its various Methods and Properties
accessed.
The Folder Object is instantiated as follows:
Dim fso, f, myPath
Set fso = CreateObject(“Scripting.FileSystemObject”) ‘Instantiate the FSO Object
myPath = $GetAppPath() & “Hst” ‘Define the path to the folder of
interest
Set f = fso.GetFolder(myPath) ‘Instantiate the Drive Object
See the GetFolder method under the FileSystemObject Object Model section for additional details on
instantiation of the Folder Object.
Method Copy
Description: Copies a specified folder from one location to another.
Use: objFolder.Copy (destination, [overwrite])
Arguments: objFolder
Required. The name of a Folder Object previously instantiated.
destination
Required. Destination where the folder is to be copied. Wildcard characters are not allowed.
overwrite
Optional. Boolean value that is True (default) if existing folders are to be overwritten, False if
they are not.
Return: None
Remarks: The results of the Copy method on a Folder are identical to operations performed using
FileSystemObject.CopyFolder where the folder referred to by object is passed as an argument.
You should note, however, that the alternative method is capable of copying multiple folders.
Example: Dim fso, f, myFolder
Set fso = CreateObject(“Scripting.FileSystemObject”) ‘Instantiate the FSO object
myFolder = $getAppPath() & “Hst” ‘Application Folder for Historical files
Set f = fso.GetFolder (myFolder)
f.Copy (myFolder & “Temp”) ‘Creates folder /HstTemp and copies
files
Method: CreateTextFile
Description: Creates a specified file name and returns a TextStream object that can be used to read from or
write to the file
Use: Set objFile = objFolde.CreateTextFile(filename[, overwrite[, Unicode]])
Arguments: objFolder
Required. The name of a Folder Object previously instantiated.
filename
Required. A string expression that identifies the file to create
overwrite
Optional. Boolean value that indicates whether you can overwrite an existing file. The value is
True if the file can be overwritten, False if it can't be overwritten. If omitted, existing files are
not overwritten (default False).
unicode
Optional. Boolean value that indicates whether the file is created as a Unicode or ASCII file. If
the value is True, the file is created as a Unicode file. If the value is False, the file is created
as an ASCII file. If omitted, an ASCII file is assumed.
Remarks: None
InduSoft, Ltd. 237