hw_api->checkout

(No version information available, might be only in CVS)

hw_api->checkout — Checks out an object

Descripción

hw_api

bool checkout ( array $parameter )

This function checks out an object or a whole hierarchy of objects.

Lista de parámetros

parameter

The parameters array contains the required element 'objectIdentifier' and the optional element 'version', 'mode' and 'objectQuery'. 'mode' can be one of the following values:

HW_API_CHECKIN_NORMAL: Checks out an object. The object must be a document.
HW_API_CHECKIN_RECURSIVE: If the object to check out is a collection, all children will be checked out recursively if they are documents. Trying to check out a collection would result in an error.

Valores retornados

Devuelve TRUE si todo se llevó a cabo correctamente, FALSE en caso de fallo.

Ver también

hw_api->checkin