<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>hw_api->lock</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="Manual do PHP"
HREF="index.html"><LINK
REL="UP"
TITLE="Hyperwave API Functions"
HREF="ref.hwapi.html"><LINK
REL="PREVIOUS"
TITLE="hw_api->link"
HREF="function.hwapi-link.html"><LINK
REL="NEXT"
TITLE="hw_api->move"
HREF="function.hwapi-move.html"><META
HTTP-EQUIV="Content-type"
CONTENT="text/html; charset=UTF-8"></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"
>Manual do PHP</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.hwapi-link.html"
ACCESSKEY="P"
>Anterior</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.hwapi-move.html"
ACCESSKEY="N"
>Próxima</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.hwapi-lock"
></A
>hw_api->lock</H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN74295"
></A
><P
> (no version information, might be only in CVS)</P
>hw_api->lock -- Locks an object</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN74298"
></A
><H2
>Description</H2
>bool <B
CLASS="methodname"
>hw_api->lock</B
> ( array parameter )<BR
></BR
><P
> Locks an object for exclusive editing by the user calling this function.
The object can be only unlocked by this user or the system user. The
parameter array contains the required element 'objectIdentifier' and the
optional parameters 'mode' and 'objectquery'.
'mode' determines how an object is locked.
<TT
CLASS="constant"
><B
>HW_API_LOCK_NORMAL</B
></TT
> means,
an object is locked until it is unlocked.
<TT
CLASS="constant"
><B
>HW_API_LOCK_RECURSIVE</B
></TT
>
is only valid for collection and locks all objects
within the collection and possible subcollections.
<TT
CLASS="constant"
><B
>HW_API_LOCK_SESSION</B
></TT
> means, an
object is locked only as long as the session is valid.
</P
><P
> See also <A
HREF="function.hwapi-unlock.html"
><B
CLASS="function"
>hwapi_unlock()</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-link.html"
ACCESSKEY="P"
>Anterior</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Principal</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.hwapi-move.html"
ACCESSKEY="N"
>Próxima</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>hw_api->link</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.hwapi.html"
ACCESSKEY="U"
>Acima</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>hw_api->move</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
