hw_api->unlock()

hw_api->unlock - Unlocks a locked object

Syntax

bool hw_api->unlock (array $parameter)

Arguments

• parameter - The parameter array contains the required element \'objectIdentifier\' and the optional parameters \'mode\' and \'objectquery\'. The meaning of \'mode\' is the same as in function hwapi_lock().

Description

Unlocks a locked object. Only the user who has locked the object and the system user may unlock an object.

Version

PHP 4, 5 < 5.2.0, PECL hwapi SVN

Return value

Returns TRUE on success or an object of class HW_API_Error.