WSH » Objects » WshSpecialFolders

The WshSpecialFolders object is a read-only collection object that contains all the special Windows folders such as the desktop folder, the Start Menu folder, and the personal document folder.

This object cannot be instantiated directly. It can only be accessed through the WshShell.SpecialFolders object.

As with all collection objects, the WshSpecialFolders collection can be iterated using the VBScript "For Each .. In" statement, but cannot be iterated using the JScript "for .. in" syntax.

Properties

length

Syntax: object.length

The length property is read only and returns a Long value which is the number of items in the collection.

Methods

Count

Syntax: object.Count (())

The Count method returns a Long value which is the number of items in the collection.

Item

Syntax: object[.Item] (lngIndex)

The Item method is the default method of the WshSpecialFolders object. It takes a single argument of type Long, and returns the element in the collection at the specified position. Indexing starts at zero. If there is no element at the requested index, a "Subscript out of range" error is generated. A key string can also be used to access the items in the WshSpecialFolders. If key string is an invalid key, a NULL will be returned.