hw_api::checkout

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

hw_api::checkout — Verifica un objeto

Descripción

hw_api::checkout ( array $parameter ) : bool

Esta función verifica un objeto o una jerarquía entera de objetos.

Parámetros

parameter

El parámetro es un array que contiene el elemento obligatorio 'objectIdentifier' y el elemento opcional 'version', 'mode' y 'objectQuery'. 'mode' puede tomar uno de los valores siguientes:

HW_API_CHECKIN_NORMAL
Verifica un objeto. El objeto debe ser un documento.
HW_API_CHECKIN_RECURSIVE
Si el objeto a verificar es una colección, todos sus hijos serán verificados recursivamente si son documentos. El intento de verificar una colección devolvería un error.

Valores devueltos

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

Ver también