(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)
hw_api::remove — オブジェクトを削除する
$parameter
) : bool指定した親から、オブジェクトを削除します。コレクションは、 再帰的に削除されます。
parameterオプションのオブジェクトクエリを渡し、 条件を満たすオブジェクトのみを削除することも可能です。 それが最後のインスタンスである場合、オブジェクトは物理的に削除されます。
パラメータの配列には、必須要素 'objectidentifier' および 'parentidentifier' が含まれます。 ユーザーやグループを削除したい場合には 'parentidentifier' は省略することができます。
オプションのパラメータ 'mode' は、削除をどのように行うかを指定します。 normal モードは、すべてのインスタンスが削除されるまで物理的な削除を行いません。 physical モードは、オブジェクトの全インスタンスが即時に削除されます。 removelinks モードは、そのオブジェクトが参照している先、 およびそのオブジェクトを参照している元も含めて削除されます。 nonrecursive の場合は、再帰的な削除は行われません。 空でないコレクションを削除しようとすると、エラーが発生します。
成功した場合に TRUE を、失敗した場合に FALSE を返します。