complexType "lockType"
Namespace:
http://schemas.microsoft.com/hs/2001/10/myDocuments
Content:
empty, 2 attributes
Defined:
globally in myDocuments.xsd; see XML source
Includes:
definitions of 2 attributes
Used:
at 1 location
XML Representation Summary
<...
   
 = 
xsd:dateTime
 = 
xsd:int
/>
All Direct / Indirect Based Elements (1):
lock (in document)
Known Usage Locations
Annotation
This element is used for document level locking. Because locks must be taken in an atomic fashion, this method, rather than a standard update, is necessary . If the lock is successfully taken, then it can be released by calling the update <b>method</b> and setting the taken attribute to 0. If a lock has been taken but should be renewed, set the <b>Force</b> flag to TRUE when calling this method. The <b>Force</b> flag should be used only to renew a lock that was previously successfully taken. Parameters <li>The query must result in a LOCK element for a specific document.</li> <li>The single BOOL parameter <b>Force</b> which, if true, takes the lock and ignores the current state of the <b>Taken</b> attribute.</li> <li>A <b>datetime</b> that specifies when the lock should automatically expire. To avoid holding locks when the client holding the lock crashes, this should be set to a reasonably small delta from the time the lock is taken. It is best to periodically refresh the lock and have relatively small lock expirations times.</li>
XML Source (see within schema source)
<xsd:complexType name="lockType">
<xsd:annotation>
<xsd:documentation>
This element is used for document level locking.

Because locks must be taken in an atomic fashion, this method, rather than a standard update, is necessary .
If the lock is successfully taken, then it can be released by calling the update
<b>method</b>
and setting
the taken attribute to 0. If a lock has been taken but should be renewed, set the
<b>Force</b>
flag to TRUE
when calling this method. The
<b>Force</b>
flag should be used only to renew a lock that was previously successfully
taken.

Parameters
<li>
The query must result in a LOCK element for a specific document.
</li>
<li>
The single BOOL parameter
<b>Force</b>
which, if true, takes the lock and ignores the current state of the
<b>Taken</b>
attribute.
</li>
<li>
A
<b>datetime</b>
that specifies when the lock should automatically expire. To avoid holding locks when the client holding the lock crashes, this should be set to a reasonably
small delta from the time the lock is taken.
It is best to periodically refresh the lock and have relatively small lock expirations times.
</li>
</xsd:documentation>
</xsd:annotation>
<xsd:attribute maxOccurs="1" minOccurs="1" name="taken" type="xsd:int">
<xsd:annotation>
<xsd:documentation>
If 0, then no lock has been taken. If 1, then a lock is being held for the document.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute maxOccurs="1" minOccurs="0" name="expires" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>
If the lock has been taken, then this optional attribute specifies when the lock should be automatically released.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
Attribute Detail (all declarations; 2/2)
expires
Type:
xsd:dateTime, predefined
Use:
optional
Defined:
locally within (this) lockType complexType
If the lock has been taken, then this optional attribute specifies when the lock should be automatically released.
XML Source (see within schema source)
<xsd:attribute maxOccurs="1" minOccurs="0" name="expires" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>
If the lock has been taken, then this optional attribute specifies when the lock should be automatically released.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
taken
Type:
xsd:int, predefined
Use:
optional
Defined:
locally within (this) lockType complexType
If 0, then no lock has been taken. If 1, then a lock is being held for the document.
XML Source (see within schema source)
<xsd:attribute maxOccurs="1" minOccurs="1" name="taken" type="xsd:int">
<xsd:annotation>
<xsd:documentation>
If 0, then no lock has been taken. If 1, then a lock is being held for the document.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>