Share via


atEnd Method

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

function atEnd() : Boolean

Remarks

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.

Example

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 += "\n";

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

Requirements

Version 2

Applies To:

Enumerator Object

See Also

Reference

item Method (Visual Studio - JScript)

moveFirst Method

moveNext Method