infoRouter Document Management System - Web Services API Documentation
UnLock
Unlocks a document or the documents in the specified path.
Syntax
Public Function UnLock(ByVal AuthenticationTicket As String, _
ByVal Path As String, _
ByVal force As Boolean) As System.Xml.XmlDocument
Parameters

AuthenticationTicket

infoRouter Authentication Ticket

Path

The Path of a document on the server.

Force

If some one else holds the lock on the specified document forces unlocking the document.

Return Value
returns xml fragment. <br>
<response success="true" error=""><br>
if success = "true", the document has been unlocked.<br>
if success = "false", the error attribute returns the error description.
Remarks
The document must be previously locked. If the "force" parameter set to "True" the caller must have "Full Control" permissions on the document.
Example
Public Sub Unlock_Sample() 
Const IRAuthenticationTicket As String = "sid-xxxxxxxxxxxxxxx"
Const IR_DocumentPath As String = "Public/Images/NinePeople.jpg"

'Set to True if the document locked by someone else.
Const IR_ForceUnlock As Boolean = False

Dim IR_Obj As InfoRouter.srv
Dim xmlResponse As System.Xml.XmlElement

Try

IR_Obj = New InfoRouter.srv

xmlResponse = IR_Obj.UnLock(IRAuthenticationTicket, _
IR_DocumentPath, _
IR_ForceUnlock)

If xmlResponse.GetAttribute("success") = "true" Then
Console.WriteLine("The document has been unlocked.")
Else
Console.WriteLine("The document cannot be unlocked.")
Console.WriteLine("server response:" & xmlResponse.GetAttribute("error"))
End If
xmlResponse = Nothing

Catch ex As Exception
Console.WriteLine("error:" & ex.Message)
Finally
IR_Obj = Nothing
End Try
End Sub
See Also
Lock | UploadDocument
Syntax based on infoRouter Document Management System Web Services API Version 7.0
Copyright() 1998-2003 Active Innovations, Inc.
infoRouter Document Management System