<HTML ><HEAD ><TITLE >hw_api->checkout</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="PHP Manual" HREF="index.html"><LINK REL="UP" TITLE="Hyperwave API functions" HREF="ref.hwapi.html"><LINK REL="PREVIOUS" TITLE="hw_api->checkin" HREF="function.hwapi-checkin.html"><LINK REL="NEXT" TITLE="hw_api->children" HREF="function.hwapi-children.html"><META HTTP-EQUIV="Content-type" CONTENT="text/html; charset=ISO-8859-1"></HEAD ><BODY CLASS="refentry" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#840084" ALINK="#0000FF" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >PHP Manual</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="function.hwapi-checkin.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="function.hwapi-children.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="function.hwapi-checkout" ></A >hw_api->checkout</H1 ><DIV CLASS="refnamediv" ><A NAME="AEN32461" ></A ><P > (no version information, might be only in CVS)</P >hw_api->checkout -- Checks out an object</DIV ><DIV CLASS="refsect1" ><A NAME="AEN32464" ></A ><H2 >Description</H2 >object <B CLASS="methodname" >checkout</B > ( array parameter)<BR ></BR ><P > This function checks out an object or a whole hiearchie of objects. The parameters array contains the required element 'objectIdentifier' and the optional element 'version', 'mode' and 'objectQuery'. 'mode' can be one of the following values: <P ></P ><DIV CLASS="variablelist" ><DL ><DT >HW_API_CHECKIN_NORMAL</DT ><DD ><P > Checks out an object. The object must be a document. </P ></DD ><DT >HW_API_CHECKIN_RECURSIVE</DT ><DD ><P > 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. </P ></DD ></DL ></DIV > </P ><P > See also <A HREF="function.hwapi-checkin.html" ><B CLASS="function" >hwapi_checkin()</B ></A >. </P ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="function.hwapi-checkin.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="function.hwapi-children.html" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >hw_api->checkin</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="ref.hwapi.html" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >hw_api->children</TD ></TR ></TABLE ></DIV ></BODY ></HTML >