atEnd Method (Windows Scripting - JScript)

  • Article

 

Returns a Boolean value indicating if the enumerator is at the end of the collection.

Syntax

myEnum.atEnd()

Remarks

The required myEnum reference is any Enumerator object.

The atEnd method returns true if the current item is the last one in the collection, the collection is empty, or the current item is undefined. Otherwise, it returns false.

In following code, the atEnd method is used to determine if the end of a list of drives has been reached:

function ShowDrives()
{
    var s = "";
    var bytesPerGB = 1024 * 1024 * 1024;

    var fso = new ActiveXObject("Scripting.FileSystemObject");
    var e = new Enumerator(fso.Drives);

    e.moveFirst();
    while (e.atEnd() == false)
    {
        var drv = e.item();

        s += drv.Path + " - ";

        if (drv.IsReady)
        {
            var freeGB = drv.FreeSpace / bytesPerGB;
            var totalGB = drv.TotalSize / bytesPerGB;

            s += freeGB.toFixed(3) + " GB free of ";
            s += totalGB.toFixed(3) + " GB";
        }
        else
        {
            s += "Not Ready";
        }

        s += "<br />";

        e.moveNext();
    }
    return(s);
}

Requirements

Version 2

Applies To: Enumerator Object (Windows Scripting - JScript)

Change History

Date

History

Reason

September 2009

Modified example.

Information enhancement.

See Also

item Method (Windows Scripting - JScript)
moveFirst Method (Windows Scripting - JScript)
moveNext Method (Windows Scripting - JScript)
Enumerator Object (Windows Scripting - JScript)