VBScript Methods of FSO File Object

Some typical predefined Elements are.

• FSO File Object:
  • Copy Method
  • Delete Method
  • Move Method
  • OpenAsTextStream Method ≡ TextStream object

Copy Method

last updated 16 Dec 2017

is to copy the associated file or folder object to the specified destination according to the specified overwrite setting.

Syntax

fsofolderobjvar.Copy( destination[, overwrite] )

fsofileobjvar.Copy( destination[, overwrite] )

Argument

fsofolderobjvar | fsofileobjvarRequired. to specify the associated Object instance reference.CopyRequired Keyword. to specify the Method of associated Object.destinationRequired. Destination where the file or folder is to be copied. Wildcard characters are not allowed.overwriteOptional. Boolean value that is True (default) if existing files or folders are to be overwritten; False if they are not.

Remark

• The results of the Copy method on a File or Folder are identical to operations performed using FileSystemObject.CopyFile or FileSystemObject.CopyFolder where the file or folder referred to by object is passed as an argument.
• However, that the alternative methods are capable of copying multiple files or folders.

Applied to

Folder Object, File Object

Delete Method

last updated 16 Dec 2017

is to delete the associated file or folder object according to the force setting.

Syntax

fsofolderobjvar.Delete( [force])

fsofileobjvar.Delete( [force])

Argument

fsofolderobjvar | fsofileobjvarRequired. to specify the associated Object instance reference.DeleteRequired Keyword. to specify the Method of associated Object.forceOptional. Boolean value that is True if files or folders with the read-only attribute set are to be deleted; False (default) if they are not.

Remark

• An error occurs if the specified file or folder does not exist.
• The results of the Delete method on a File or Folder are identical to operations performed using FileSystemObject.DeleteFile or FileSystemObject.DeleteFolder.
• The Delete method does not distinguish between folders that have contents and those that do not.
• The specified folder is deleted regardless of whether or not it has contents.

Applied to

Folder Object, File Object

Move Method

last updated 16 Dec 2017

is to move folder or file of the associated Folder or File Object to the specified destination.

Syntax

fsofolderobjvar.Move( destination )

fsofileobjvar.Move( destination )

Argument

fsofolderobjvar | fsofileobjvarRequired. to specify the associated Object instance reference.MoveRequired Keyword. to specify the Method of associated Object.destinationRequired. Destination where the file or folder is to be moved. Wildcard characters are not allowed.

Remark

• The results of the Move method on a File or Folder are identical to operations performed using FileSystemObject.MoveFile or FileSystemObject.MoveFolder.
• However, that the alternative methods are capable of moving multiple files or folders.

Applied to

Folder Object, File Object

OpenAsTextStream Method

last updated 16 Dec 2017

is to open a TextStream Object of the associated File Object according to specified optional iomode setting and format setting for reading from, writing to, or appending to the file.

Syntax

fsofileobjvar.OpenAsTextStream([iomode, [format]])

Argument

fsofileobjvarRequired. to specify the associated Object instance reference.OpenAsTextStreamRequired Keyword. to specify the Method of associated Object.iomodeOptional Setting. Indicates input/output mode. Can be one of three constantsformatOptional Setting. One of three Tristate values used to indicate the format of the opened file. If omitted, the file is opened as ASCII.

Setting

iomode argument:

format argument:

Remark

• The OpenAsTextStream method provides the same functionality as the OpenTextFile method of the FileSystemObject. In addition, the OpenAsTextStream method can be used to write to a file.

Applied to

File Object