ssCore.FileSys.getFolderSize

Get the size of a folder and all subfolders. Hidden files and folders are included in the total.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

path - A fully qualified path to a folder. This parameter supports monikers.


Output Parameters:

result - Size of folder in bytes.

kb - Size of folder in kilobytes.

mb - Size of folder in megabytes.

gb - Size of folder in gigabytes.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.FileSys.getFolderSize( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.FileSys.getFolderSize( paramsObject );


Notes:

None.


Examples:

var return_obj = ssCore.FileSys.getFolderSize({path:"startdir://subfolder"});

ssDebug.trace(return_obj.result + " bytes");
ssDebug.trace(return_obj.mb + " megabytes");