📄 function.hwapi-checkout.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>Checks out an object</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.hwapi-checkin.html">hw_api->checkin</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.hwapi-children.html">hw_api->children</a></div> <div class="up"><a href="ref.hwapi.html">Hyperwave API Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div><hr /><div id="function.hwapi-checkout" class="refentry"> <div class="refnamediv"> <h1 class="refname">hw_api->checkout</h1> <p class="verinfo">(No version information available, might be only in CVS)</p><p class="refpurpose"><span class="refname">hw_api->checkout</span> — <span class="dc-title">Checks out an object</span></p> </div> <div class="refsect1 description"> <h3 class="title">Description</h3> <div class="classsynopsis"> <div class="ooclass"><b class="classname">hw_api</b></div> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><b>checkout</b></b></span> ( <span class="methodparam"><span class="type">array</span> <tt class="parameter">$parameter</tt></span> )</div> </div> <p class="para"> This function checks out an object or a whole hierarchy of objects. </p> </div> <div class="refsect1 parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><i><tt class="parameter">parameter</tt></i></span> <dd> <p class="para"> The parameters array contains the required element 'objectIdentifier' and the optional element 'version', 'mode' and 'objectQuery'. 'mode' can be one of the following values: <dl> <dt> <br /><span class="term"><b><tt>HW_API_CHECKIN_NORMAL</tt></b></span> <dd> <span class="simpara"> Checks out an object. The object must be a document. </span> </dd> </dt> <dt> <span class="term"><b><tt>HW_API_CHECKIN_RECURSIVE</tt></b></span> <dd> <span class="simpara"> 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. </span> </dd> </dt> </dl> </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <b><tt>TRUE</tt></b> on success or <b><tt>FALSE</tt></b> on failure. </p> </div> <div class="refsect1 seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><a href="function.hwapi-checkin.html" class="xref">hw_api->checkin</a></li> </ul> </p> </div></div><hr /><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.hwapi-checkin.html">hw_api->checkin</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.hwapi-children.html">hw_api->children</a></div> <div class="up"><a href="ref.hwapi.html">Hyperwave API Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -