hw_api::lock
(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)
hw_api::lock — Verrouille un objet
Description
$parameter
)Verrouille un objet pour le faire éditer exclusivement par l'utilisateur qui appelle cette fonction. L'objet ne peut être déverrouillé que par cet utilisateur ou par le système.
Liste de paramètres
-
parameter -
Le paramètre
parameterest un tableau qui contient l'élément obligatoire "objectIdentifier" et les paramètres optionnels "mode" et "objectquery"."mode" détermine comment l'objet est verrouillé.
HW_API_LOCK_NORMALsignifie que l'objet est verrouillé jusqu'à son déverrouillage.HW_API_LOCK_RECURSIVEest uniquement valide pour une collection et verrouille tous les objets de la collection et des sous-collections.HW_API_LOCK_SESSIONsignifie que l'objet est verrouillé aussi longtemps que tient la session en cours.
Valeurs de retour
Cette fonction retourne TRUE en cas de
succès ou FALSE si une erreur survient.
