hw_api->lock
(No version information available, might be only in CVS)
hw_api->lock — オブジェクトをロックする
説明
hw_api
bool lock
( array $parameter
)
この関数をコールすると、オブジェクトを排他的に編集するためにロックします。 ロックを解除できるのは、ロックしたユーザあるいはシステムユーザのみです。
パラメータ
- parameter
-
パラメータの配列には、必須要素 'objectIdentifier' とオプションのパラメータ 'mode' および 'objectquery' が含まれます。
'mode' は、オブジェクトをどのようにロックするのかを指定します。 HW_API_LOCK_NORMAL は、 ロックが解除されるまでオブジェクトをロックします。 HW_API_LOCK_RECURSIVE はコレクションの場合にのみ有効で、 コレクション内のすべてのオブジェクト・子コレクションをロックします。 HW_API_LOCK_SESSION は、 セッションが有効な間のみオブジェクトをロックします。
返り値
成功した場合に TRUE を、失敗した場合に FALSE を返します。