VBScript Reference Manual for InduSoft Web Studio

More documents

Recommendations

Info

VBScript Reference Manual InduSoft Web Studio TextStream Object The TextStream Object allows the programmer to sequentially access a text file. Once the TextStream object is instantiated, it can be referred to as an object from VBScript and its various Methods and Properties accessed. The TextStream object can be instantiated in three different ways. These are • Through the CreateTextFile method of the FSO object • Through the OpenTextFile method of the FSO object • Through the OpenAsTextStream method of the File Object There are subtle differences between these methods. The CreateTextFile is used to create a file and a TextStream object. This method can optionally overwrite an existing object. The OpenTextFile opens an existing file and returns a TextStream object, but can optionally create the filename if it does not exist. The OpenAsTextStream object opens an existing file and returns a TextStream object. This method gives an error if the text file does not exist, there is no option to create the file if it does not exist. Another difference is that the CreateTextFile method opens a TextStream object for reading and writing, while the OpenTextFile and OpenAsTextStream methods open a TextStream object for reading, writing or appending. Examples of the various approaches to instantiating the TextStream object are: Instantiating a TextStream object with the CreateTextFile Method Dim fso, f, myfile Set fso = CreateObject(“Scripting.FileSystemObject”) ‘Instantiate the FSO object myFile = $getAppPath() & “notes.txt” ‘Specify the app directory & file Set f = fso.CreateTextFile(myFile, True, True) ‘Open as UniCode TextStream object Instantiating a TextStream object with the OpenTextFile Method Constant forReading = 1, forWriting = 2, forAppending = 8 Dim fso, myfile, tso Set fso = CreateObject(“Scripting.FileSystemObject”) ‘Instantiate the FSO object myFile = $getAppPath() & “notes.txt” ‘Specify the app directory & file Set tso = fso.OpenTextFile(myFile, ForWriting, True, True) ‘Open as UniCode TextStream object Instantiating a TextStream object with the OpenAsTextStream Method Constant forReading = 1, forWriting = 2, forAppending = 8 Dim fso, f, myfile, tso Set fso = CreateObject(“Scripting.FileSystemObject”) ‘Instantiate the FSO object myFile = $getAppPath() & “notes.txt” ‘Specify the app directory & file Set f = fso.GetFile(myFile) ‘Instantiate the file object Set tso = f.OpenAsTextStream(forAppending, True) ‘Open as UniCode TextStream object See the CreateTextFile and OpenTextFile methods under the FileSystemObject Object Model section for additional details on instantiation of the TextStream Object. See the OpenAsTextStream method under the File Object section for additional details on instantiation of the TextStream Object The TextStream object supports either ASCII or UniCode characters, according to the argument settings when calling the method used to instantiate the TextStream object. 250 InduSoft, Ltd.
InduSoft Web Studio VBScript Reference Manual Method: Close Description: Closes an open TextStream file Use: objTso.Close Arguments: objTso Required. The name of a TextStream Object previously instantiated. Return: None Remarks: The Close method closes the file, but still need to set the object variable to Nothing to release memory. (e.g. “Set objTso = Nothing” Example: Dim fso, f, myfile Set fso = CreateObject(“Scripting.FileSystemObject”) ‘Instantiate the FSO object myFile = $getAppPath() & “notes.txt” ‘Specify the app directory & file Set f = fso.CreateTextFile(myFile, True) f.WriteLine (“this is a note”) f.Close ‘Close the document Method: Read Description: Reads a specified number of characters from a TextStream file and returns the resulting string. Use: strChars = objTso.Read(numCharacters) Arguments: objTso Required. The name of a TextStream Object previously instantiated. numCharacters Required. The number of characters you want to read from the file Return: A specified number of characters from the file Remarks: None Example: Const ForReading=1, Const ForWriting=2, ForAppending=8 Dim fso, f, myfile, s Set fso = CreateObject(“Scripting.FileSystemObject”) ‘Instantiate the FSO object myFile = $getAppPath() & “notes.txt” ‘Specify the app directory & file Set f = fso.OpenTextFile(myFile, ForReading) s = f.Read(10) ‘Read 10 characters MsgBox “First 10 characters = “ & s ‘Display f.Close ‘Close the document Method: ReadAll Description: Reads the entire TextStream file and returns the resulting string. Use: strChars = objTso.ReadAll Arguments: objTso Required. The name of a TextStream Object previously instantiated. Return: The entire TextStream file. Remarks: VBScript does not have a limit on the resultant character string length other than the available memory. Example: Const ForReading=1, Const ForWriting=2, ForAppending=8 Dim fso, f, myfile, s Set fso = CreateObject(“Scripting.FileSystemObject”) ‘Instantiate the FSO object myFile = $getAppPath() & “notes.txt” ‘Specify the app directory & file Set f = fso.OpenTextFile(myFile, ForReading) s = f.ReadAll ‘Read entire file MsgBox “File contents = “ & s ‘Display it f.Close InduSoft, Ltd. 251
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:
Page 167 and 168:
Page 169 and 170:
Page 171 and 172:
Page 173 and 174:
Page 175 and 176:
Page 177 and 178:
Page 179 and 180:
Page 181 and 182:
Page 183 and 184:
Page 185 and 186:
Page 187 and 188:
Page 189 and 190:
Page 191 and 192:
Page 193 and 194:
Page 195 and 196:
Page 197 and 198:
Page 199 and 200: InduSoft Web Studio VBScript Refere
Page 249: 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?