getResourceTotal

The getResourceTotal function returns the value of total amount for a particular resource in a resources automation object.

Syntax

nTotal = getResourceTotal(resourcePath, resourceName)

Arguments

resourcePath (String): Specifies the path of the resource object.
resourceName (String): Specifies the name of the resource in the resources object whose total amount needs to be returned.

Return Value

nTotal (Int): Returns the total number for the specified resource. If the resource does not exist, -1 is returned.

Example

nTotal = getResourceTotal("/Resources/Locks", "DiskLock");