VBScript Run-Time Library Reference

Office VBScript

Microsoft® Visual Basic® Scripting Edition Scripting Run-Time Library Reference  Language Reference 
Version Information 



 Feature Information

 Alphabetic Keyword List

 Constants

 Methods

 Objects

 Properties

 

Welcome to the Scripting Run-Time Library Reference

These handy blocks of information will help you explore the many different parts of the Scripting Run-Time Library.

You'll find all the parts of the Scripting Run-Time Library listed alphabetically under the Alphabetic Keyword List. But if you want to examine just one category, say, objects, each language category has its own, more compact section.

How's it work? Click on one of the headings to the left to display a list of items contained in that category. From this list, select the topic that you want to view. Once you've opened that topic, you can easily link to other related sections.

So, go ahead and take a look! Study some statements, mull over the methods, or figure out a few functions. You'll see just how versatile the Scripting Run-Time Library can be!

Features
Description
Microsoft Scripting Run-Time Features
List of features currently in Microsoft Scripting Run-Time Library .
Language Element
Description
Add Method (Dictionary) Adds a key and item pair to a Dictionary object.
Add Method (Folders) Adds a new Folder to a Folders collection.
AtEndOfLine Property Returns True if the file pointer immediately precedes the end-of-line marker in a TextStream file; False if it is not.
AtEndOfStream Property Returns True if the file pointer is at the end of a TextStream file; False if it is not.
Attributes Property Sets or returns the attributes of files or folders.
AvailableSpace Property Returns the amount of space available to a user on the specified drive or network share.
BuildPath Method Appends a name to an existing path.
Close Method Closes an open TextStream file.
Column Property Returns the column number of the current character position in a TextStream file.
CompareMode Property Sets and returns the comparison mode for comparing string keys in a Dictionary object.
Copy Method Copies a specified file or folder from one location to another.
CopyFile Method Copies one or more files from one location to another.
CopyFolder Method Recursively copies a folder from one location to another.
Count Property Returns the number of items in a collection or Dictionary object.
CreateFolder Method Creates a folder.
CreateTextFile Method Creates a specified file name and returns a TextStream object that can be used to read from or write to the file.
DateCreated Property Returns the date and time that the specified file or folder was created.
DateLastAccessed Property Returns the date and time that the specified file or folder was last accessed.
DateLastModified Property Returns the date and time that the specified file or folder was last modified.
Delete Method Deletes a specified file or folder.
DeleteFile Method Deletes a specified file.
DeleteFolder Method Deletes a specified folder and its contents.
Dictionary Object Object that stores data key, item pairs.
Drive Object Provides access to the properties of a particular disk drive or network share.
Drive Property Returns the drive letter of the drive on which the specified file or folder resides.
DriveExists Method Returns True if the specified drive exists; False if it does not.
DriveLetter Property Returns the drive letter of a physical local drive or a network share.
Drives Collection Read-only collection of all available drives.
Drives Property Returns a Drives collection consisting of all Drive objects available on the local machine.
DriveType Constants Defines the various drive types available on the host computer, such as Fixed, Removable, CD-ROM, etc.
DriveType Property Returns a value indicating the type of a specified drive.
Exists Method Returns True if a specified key exists in the Dictionary object, False if it does not.
File Attribute Constants Defines various file attributes such as Hidden, Read-Only, etc.
File Input/Output Constants Defines constants used with file input and output.
FileExists Method Returns True if a specified file exists; False if it does not.
File Object Provides access to all the properties of a file.
Files Collection Collection of all File objects within a folder.
Files Property Returns a Files collection consisting of all File objects contained in the specified folder, including those with hidden and system file attributes set.
FileSystemObject Object Provides access to a computer's file system.
FileSystemObject Constants List of constants for the File System automation object
FileSystem Property Returns the type of file system in use for the specified drive.
Folder Object Provides access to all the properties of a folder.
Folders Collection Collection of all Folder objects contained within a Folder object.
FolderExists Method Returns True if a specified folder exists; False if it does not.
FreeSpace Property Returns the amount of free space available to a user on the specified drive or network share.
GetAbsolutePathName Method Returns a complete and unambiguous path from a provided path specification.
GetBaseName Method Returns a string containing the base name of the file (less any file extension), or folder in a provided path specification.
GetDrive Method Returns a Drive object corresponding to the drive in a specified path.
GetDriveName Method Returns a string containing the name of the drive for a specified path.
GetExtensionName Method Returns a string containing the extension name for the last component in a path.
GetFile Method Returns a File object corresponding to the file in a specified path.
GetFileName Method Returns the last file name or folder of a specified path that is not part of the drive specification.
GetFileVersion Method Returns the version number of a specified file.
GetFolder Method Returns a Folder object corresponding to the folder in a specified path.
GetParentFolderName Method Returns a string containing the name of the parent folder of the last file or folder in a specified path.
GetSpecialFolder Method Returns the special folder specified.
GetTempName Method Returns a randomly generated temporary file or folder name.
IsReady Property Returns True if the specified drive is ready; False if it is not.
IsRootFolder Property Returns True if the specified folder is the root folder; False if it is not.
Item Property Sets or returns an item for a specified key in a Dictionary object.
Items Method Returns an array containing all the items in a Dictionary object.
Key Property Sets a key in a Dictionary object.
Keys Method Returns an array containing all existing keys in a Dictionary object.
Line Property Returns the current line number in a TextStream file.
Move Method Moves a specified file or folder from one location to another.
MoveFile Method Moves one or more files from one location to another.
MoveFolder Method Moves one or more folders from one location to another.
Name Property Sets or returns the name of a specified file or folder.
OpenAsTextStream Method Opens a specified file and returns a TextStream object that can be used to read from, write to, or append to the file.
OpenTextFile Method Opens a specified file and returns a TextStream object that can be used to read from, write to, or append to the file.
ParentFolder Property Returns the folder object for the parent of the specified file or folder.
Path Property Returns the path for a specified file, folder, or drive.
Read Method Reads a specified number of characters from a TextStream file and returns the resulting string.
ReadAll Method Reads an entire TextStream file and returns the resulting string.
ReadLine Method Reads an entire line (up to, but not including, the newline character) from a TextStream file and returns the resulting string.
Remove Method Removes a key, item pair from a Dictionary object.
RemoveAll Method Removes all key, item pairs from a Dictionary object.
RootFolder Property Returns a Folder object representing the root folder of a specified drive.
SerialNumber Property Returns the decimal serial number used to uniquely identify a disk volume.
ShareName Property Returns the network share name for a specified drive.
ShortName Property Returns the short name used by programs that require the earlier 8.3 naming convention.
ShortPath Property Returns the short path used by programs that require the earlier 8.3 file naming convention.
Size Property Returns the size, in bytes, of the specified file or folder.
Skip Method Skips a specified number of characters when reading a TextStream file.
SkipLine Method Skips the next line when reading a TextStream file.
SpecialFolder Constants Defines special folders available in your operating system.
SubFolders Property Returns a Folders collection consisting of all folders contained in a specified folder, including those with Hidden and System file attributes set.
TextStream Object Facilitates sequential access to file.
TotalSize Property Returns the total space, in bytes, of a drive or network share.
Type Property Returns information about the type of a file or folder.
VolumeName Property Sets or returns the volume name of the specified drive.
Write Method Writes a specified string to a TextStream file.
WriteBlankLines Method Writes a specified number of newline characters to a TextStream file.
WriteLine Method Writes a specified string and newline character to a TextStream file.
Language Element
Description
DriveType Constants Defines the various drive types available on the host computer, such as Fixed, Removable, CD-ROM, etc.
File Attribute Constants Defines various file attributes such as Hidden, Read-Only, etc.
FileSystemObject Constants List of constants for the File System Automation object
SpecialFolder Constants Defines special folders available in your operating system.
Language Element
Description
Add Method (Dictionary) Adds a key and item pair to a Dictionary object.
Add Method (Folders) Adds a new Folder to a Folders collection.
BuildPath Method Appends a name to an existing path.
Close Method Closes an open TextStream file.
Copy Method Copies a specified file or folder from one location to another.
CopyFile Method Copies one or more files from one location to another.
CopyFolder Method Recursively copies a folder from one location to another.
CreateFolder Method Creates a folder.
CreateTextFile Method Creates a specified file name and returns a TextStream object that can be used to read from or write to the file.
Delete Method Deletes a specified file or folder.
DeleteFile Method Deletes a specified file.
DeleteFolder Method Deletes a specified folder and its contents.
DriveExists Method Returns True if the specified drive exists; False if it does not.
Exists Method Returns True if a specified key exists in the Dictionary object, False if it does not.
FileExists Method Returns True if a specified file exists; False if it does not.
FolderExists Method Returns True if a specified folder exists; False if it does not.
GetAbsolutePathName Method Returns a complete and unambiguous path from a provided path specification.
GetBaseName Method Returns a string containing the base name of the file (less any file extension), or folder in a provided path specification.
GetDrive Method Returns a Drive object corresponding to the drive in a specified path.
GetDriveName Method Returns a string containing the name of the drive for a specified path.
GetExtensionName Method Returns a string containing the extension name for the last component in a path.
GetFile Method Returns a File object corresponding to the file in a specified path.
GetFileName Method Returns the last file name or folder of a specified path that is not part of the drive specification.
GetFileVersion Method Returns the version number of a specified file.
GetFolder Method Returns a Folder object corresponding to the folder in a specified path.
GetParentFolderName Method Returns a string containing the name of the parent folder of the last file or folder in a specified path.
GetSpecialFolder Method Returns the special folder specified.
GetTempName Method Returns a randomly generated temporary file or folder name.
Items Method Returns an array containing all the items in a Dictionary object.
Keys Method Returns an array containing all existing keys in a Dictionary object.
Move Method Moves a specified file or folder from one location to another.
MoveFile Method Moves one or more files from one location to another.
MoveFolder Method Moves one or more folders from one location to another.
OpenAsTextStream Method Opens a specified file and returns a TextStream object that can be used to read from, write to, or append to the file.
OpenTextFile Method Opens a specified file and returns a TextStream object that can be used to read from, write to, or append to the file.
Read Method Reads a specified number of characters from a TextStream file and returns the resulting string.
ReadAll Method Reads an entire TextStream file and returns the resulting string.
ReadLine Method Reads an entire line (up to, but not including, the newline character) from a TextStream file and returns the resulting string.
Remove Method Removes a key, item pair from a Dictionary object.
RemoveAll Method Removes all key, item pairs from a Dictionary object.
Skip Method Skips a specified number of characters when reading a TextStream file.
SkipLine Method Skips the next line when reading a TextStream file.
Write Method Writes a specified string to a TextStream file.
WriteBlankLines Method Writes a specified number of newline characters to a TextStream file.
WriteLine Method Writes a specified string and newline character to a TextStream file.
Language Element
Description
Dictionary Object Object that stores data key, item pairs.
Drive Object Provides access to the properties of a particular disk drive or network share.
Drives Collection Read-only collection of all available drives.
File Object Provides access to all the properties of a file.
Files Collection Collection of all File objects within a folder.
FileSystemObject Object Provides access to a computer's file system.
Folder Object Provides access to all the properties of a folder.
Folders Collection Collection of all Folder objects contained within a Folder object.
TextStream Object Facilitates sequential access to a file.
Language Element
Description
AtEndOfLine Property Returns True if the file pointer immediately precedes the end-of-line marker in a TextStream file; False if it is not.
AtEndOfStream Property Returns True if the file pointer is at the end of a TextStream file; False if it is not.
Attributes Property Sets or returns the attributes of files or folders.
AvailableSpace Property Returns the amount of space available to a user on the specified drive or network share.
Column Property Returns the column number of the current character position in a TextStream file.
CompareMode Property Sets and returns the comparison mode for comparing string keys in a Dictionary object.
Count Property Returns the number of items in a collection or Dictionary object.
DateCreated Property Returns the date and time that the specified file or folder was created.
DateLastAccessed Property Returns the date and time that the specified file or folder was last accessed.
DateLastModified Property Returns the date and time that the specified file or folder was last modified.
Drive Property Returns the drive letter of the drive on which the specified file or folder resides.
DriveLetter Property Returns the drive letter of a physical local drive or a network share.
Drives Property Returns a Drives collection consisting of all Drive objects available on the local machine.
DriveType Property Returns a value indicating the type of a specified drive.
Files Property Returns a Files collection consisting of all File objects contained in the specified folder, including those with hidden and system file attributes set.
FileSystem Property Returns the type of file system in use for the specified drive.
FreeSpace Property Returns the amount of free space available to a user on the specified drive or network share.
IsReady Property Returns True if the specified drive is ready; False if it is not.
IsRootFolder Property Returns True if the specified folder is the root folder; False if it is not.
Item Property Sets or returns an item for a specified key in a Dictionary object.
Key Property Sets a key in a Dictionary object.
Line Property Returns the current line number in a TextStream file.
Name Property Sets or returns the name of a specified file or folder.
Number Property Returns or sets a numeric value specifying an error.
ParentFolder Property Returns the folder object for the parent of the specified file or folder.
Path Property Returns the path for a specified file, folder, or drive.
RootFolder Property Returns a Folder object representing the root folder of a specified drive.
SerialNumber Property Returns the decimal serial number used to uniquely identify a disk volume.
ShareName Property Returns the network share name for a specified drive.
ShortName Property Returns the short name used by programs that require the earlier 8.3 naming convention.
ShortPath Property Returns the short path used by programs that require the earlier 8.3 file naming convention.
Size Property Returns the size, in bytes, of the specified file or folder.
SubFolders Property Returns a Folders collection consisting of all folders contained in a specified folder, including those with Hidden and System file attributes set.
TotalSize Property Returns the total space, in bytes, of a drive or network share.
Type Property Returns information about the type of a file or folder.
VolumeName Property Sets or returns the volume name of the specified drive.


© 1999 Microsoft Corporation. All rights reserved.