Delicious Bookmark this on Delicious Share on Facebook SlashdotSlashdot It! Digg! Digg



PHP : Function Reference : Hyperwave API Functions : hw_api->checkout

hw_api->checkout

Checks out an object ()

hw_api {
  bool checkout(array parameter);
}

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

Parameters

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.

Return Values

Returns TRUE on success or FALSE on failure.

See Also
hw_api->checkin

Change Language


Follow Navioo On Twitter
hw_api_attribute->key
hw_api_attribute->langdepvalue
hw_api_attribute->value
hw_api_attribute->values
hw_api_attribute
hw_api->checkin
hw_api->checkout
hw_api->children
hw_api_content->mimetype
hw_api_content->read
hw_api->content
hw_api->copy
hw_api->dbstat
hw_api->dcstat
hw_api->dstanchors
hw_api->dstofsrcanchor
hw_api_error->count
hw_api_error->reason
hw_api->find
hw_api->ftstat
hwapi_hgcsp
hw_api->hwstat
hw_api->identify
hw_api->info
hw_api->insert
hw_api->insertanchor
hw_api->insertcollection
hw_api->insertdocument
hw_api->link
hw_api->lock
hw_api->move
hw_api_content
hw_api_object->assign
hw_api_object->attreditable
hw_api_object->count
hw_api_object->insert
hw_api_object
hw_api_object->remove
hw_api_object->title
hw_api_object->value
hw_api->object
hw_api->objectbyanchor
hw_api->parents
hw_api_reason->description
hw_api_reason->type
hw_api->remove
hw_api->replace
hw_api->setcommittedversion
hw_api->srcanchors
hw_api->srcsofdst
hw_api->unlock
hw_api->user
hw_api->userlist
eXTReMe Tracker