Name

Folder.CreateTextFile Method

Syntax

                  oFolderObj
                  .CreateTextFile FileName[, Overwrite[, Unicode]])
oFolderObj

Use: Required

Data Subtype: Folder object

Any object variable returning a Folder object.

FileName

Use: Required

Data Subtype: String

Any valid filename and optional path.

Overwrite

Use: Optional

Data Subtype: Boolean

Flag to indicate whether an existing file of the same name should be overwritten.

Unicode

Use: Optional

Data Subtype: Boolean

Flag to indicate whether file is to be written in Unicode or ASCII.

Return Value

A TextStream object.

Description

Creates a new file at the specified location and returns a TextStream object for that file.

Rules at a Glance

  • Filename can be a relative or absolute path. Wildcard characters are not allowed in FileName.

  • If no path is specified in Filename, the script’s current drive and directory are used. If no drive is specified in Filename, the script’s current drive is used.

  • The default value for Overwrite is False.

  • If Unicode is set to True, a Unicode file is created; otherwise it’s created as an ASCII text file.

  • The default value for Unicode is False.

Programming Tips & Gotchas

  • If the path specified in Filename does not exist, the method fails. To prevent this error, you can use the FileSystemObject object’s FolderExists method to be sure that the path is valid.

  • The newly created text file is automatically opened only for writing. If you subsequently wish to read from the file, you must first close it and reopen it in read mode.

  • If the file referred ...

Get VBScript in a Nutshell now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.