hw_api::lock

(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)

hw_api::lock — Bloquea un objeto

Descripción

hw_api::lock ( array $parameter ) : bool

Bloquea un objeto para ser editado en modo exclusivo por el usuario que llama a esta función. El objeto únicamente puede desbloquearse por ese usuario o por el usuario de sistema.

Parámetros

parameter

El parámetro es un array que contiene el elemento obligatorio 'objectIdentifier' y los parámetros opcionales 'mode' y 'objectquery'.

'mode' determina cómo se bloqueará un objeto. HW_API_LOCK_NORMAL significa que un objeto se bloqueará hasta que sea desbloqueado. HW_API_LOCK_RECURSIVE sólo es válido para objetos 'collection' y bloquea todos los objetos dentro de la colección y posibles subcolecciones. HW_API_LOCK_SESSION significa que un objeto es bloqueado únicamente mientras la sesión sea válida.

Valores devueltos

Devuelve TRUE en caso de éxito o FALSE en caso de error.

Ver también