VBScript Reference Manual for InduSoft Web Studio

More documents

Recommendations

Info

VBScript Reference Manual InduSoft Web Studio FileSystemObject (FSO) The FileSystemObject (FSO) object model is part of the VBScript Scripting Type library. It is a COM component and is used to manipulate the Windows File System from VBScript. Note that VBScript does not include commands to access files directly, instead the FSO is used. The FSO consists of collections (Drives Collection, Folders Collection, and Files Collection) that are a grouping of like objects, and individual objects (Drive object, Folder object, File object, and TextStream object). The individual objects are generally derived from a collection or accessed/created directly through the FSO. The FSO must be instantiated by the following set of statements: Dim objFso ‘Declare the variable(s) Set objFso = CreateObject(“Scripting.FileSystemObject”) ‘Instantiate the FileSystemObject FSO Properties and Methods Property Drives Description: Returns a collection of Drive objects. Use: Set objDrive = fso.Drives Arguments: fso Required. The name of a FileSystemObject object previously instantiated. Return: An object containing a collection of Drives objects Remarks: Returns a collection of Drives objects available on the local machine, including networked drives mapped to the local machine. Removable media drives do not have to have media inserted to appear in the Drives Collection. Example: Dim fso, dc, d, strDrvList Set fso = CreateObject(“Scripting.FileSystemObject”) ‘Instantiate the FSO object Set dc = fso.Drives ‘Instantiate the Drives collection object strDrvList = “” For each d in dc ‘Evaluate each drive in the drives collection strDrvList = strDrvList & d.driveLetter & “ – “ ‘Get the Drive letter If d.DriveType = 3 Then ‘See if a network drive strDrvList = strDrvList & d.ShareName ‘Yes ElseIf d.IsReady Then ‘No – is a local drive. Check if ready strDrvList = strDrvList & d.VolumeName ‘Yes – add to list End If strDrvList = strDrvList & vbCrLf ‘Add a Cr & Lf and then get next drive Next MsgBox strDrvList ‘Display the list of drives 216 InduSoft, Ltd.
InduSoft Web Studio VBScript Reference Manual Method: BuildPath Description: Appends a name to an existing path Use: fso.BuildPath(path, name) Arguments: fso Required. The name of a FileSystemObject object previously instantiated. path Required. Existing path to which name is appended. Path can be absolute or relative, and need not specify an existing folder name Required. Name being appended to the existing path. Return: None Remarks: The BuildPath method inserts an additional path separator between the existing path and the name, only if necessary. Does not check for a valid path. Example: Dim fso, path, newpath Set fso = CreateObject("Scripting.FileSystemObject") path = $getAppPath() newpath = fso.BuildPath(path, "SubFolder") Method: CopyFile Description: Copies one or more files from one location to a new location Use: fso.CopyFile (source, destination[, overwrite]) Arguments: fso Required. The name of a FileSystemObject object previously instantiated. source Required. A character string file specification, which can include wildcard characters, for one or more files to be copied. destination Required. Character string destination where the file or files from source are to be copied. Wildcard characters are not allowed in the destination string. overwrite Optional. Boolean value that indicates if existing files are to be overwritten. If True, files are overwritten; if False, they are not. The default is True. Note that CopyFile will fail if destination has the read-only attribute set, regardless of the value of overwrite. Return: None Remarks: Wildcard characters can only be used in the last path component of the source argument. If source contains wildcard characters or destination ends with a path separator (\), it is assumed that destination is an existing folder in which to copy matching files. Otherwise, destination is assumed to be the name of a file to create. In either case, three things can happen when a file is copied. • If destination does not exist, source gets copied. This is the usual case. • If destination is an existing file, an error occurs if overwrite is False. Otherwise, an attempt is made to copy source over the existing file. • If destination is a directory, an error occurs. (Occurs because the directory doesn’t exist). An error also occurs if a source using wildcard characters doesn't match any files. The CopyFile method stops on the first error it encounters. No attempt is made to roll back or undo any changes made before an error occurs. Example: Const OverWrite = False Dim fso, srcFiles, destPath Set fso = CreateObject("Scripting.FileSystemObject") srcFiles = $getAppPath() & “Alarm\*.*” destPath = $getAppPath() & “AlarmHistory” If fso.FolderExists (destPath) = False Then fso.CreateFolder (destPath) End If fso.CopyFile srcFiles, destPath InduSoft, Ltd. 217
Page 1 and 2:
VBScript Reference Manual for InduS
Page 3 and 4:
InduSoft Web Studio VBScript Refere
Page 5 and 6:
Page 7 and 8:
Page 9 and 10:
Page 11 and 12:
Page 13 and 14:
Page 15 and 16:
Page 17 and 18:
Page 19 and 20:
Page 21 and 22:
Page 23 and 24:
Page 25 and 26:
Page 27 and 28:
Page 29 and 30:
Page 31 and 32:
Page 33 and 34:
Page 35 and 36:
Page 37 and 38:
Page 39 and 40:
Page 41:
Page 44 and 45:
VBScript Reference Manual InduSoft
Page 46 and 47:
Page 48 and 49:
Page 50 and 51:
Page 52 and 53:
Page 54 and 55:
Page 56 and 57:
Page 58 and 59:
Page 60 and 61:
Page 62 and 63:
Page 64 and 65:
Page 66 and 67:
Page 68 and 69:
Page 70 and 71:
Page 72 and 73:
Page 74 and 75:
Page 76 and 77:
Page 78 and 79:
Page 80 and 81:
Page 82 and 83:
Page 84 and 85:
Page 86 and 87:
Page 88 and 89:
Page 90 and 91:
Page 92 and 93:
Page 94 and 95:
Page 96 and 97:
Page 98 and 99:
Page 100 and 101:
Page 102 and 103:
Page 104 and 105:
Page 106 and 107:
Page 108 and 109:
Page 110 and 111:
Page 112 and 113:
Page 114 and 115:
Page 116 and 117:
Page 118 and 119:
Page 120:
Page 123 and 124:
Page 125 and 126:
Page 127 and 128:
Page 129 and 130:
Page 131 and 132:
Page 133 and 134:
Page 135 and 136:
Page 137 and 138:
Page 139 and 140:
Page 141 and 142:
Page 143 and 144:
Page 145 and 146:
Page 147 and 148:
Page 149 and 150:
Page 151 and 152:
Page 153 and 154:
Page 155 and 156:
Page 157 and 158:
Page 159 and 160:
Page 161 and 162:
Page 163 and 164:
Page 165 and 166: InduSoft Web Studio VBScript Refere
Page 215: InduSoft Web Studio VBScript Refere
Page 255: InduSoft Web Studio VBScript Refere
show all

VBScript Reference Manual for InduSoft Web Studio

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?