CA Process Automation System Functions › lockResource

lockResource

The lockResource function locks or unlocks one or more resources in a resource object. If you specify a value for resourceName, it resets only that resource. If you leave resourceName empty, it resets all of the resources in the resources object.

Notes:

• If resources that do not exist are provided as input, resources are still created.
• If you specify a value for resourceName and that resource does not exist, the resource is created with an amount of zero and set to the specified state.

Syntax

bSuccess = lockResource(resourcePath, resourceName, state)

Arguments

resourcePath (String)

Specifies the path of the resources object.

resourceName (String)

Specifies the name of the resource in the resources object.

state (Boolean)

Specifies whether the resource should be locked or unlocked. Set to true for locked and false for unlocked.

Return Value

bSuccess (Boolean)

Returns true if the function succeeds or false if it fails.

Example

bSuccess = lockResource("/Resources/Locks", "InvLock", true);