infoRouter Document Management System Web Services API

infoRouter Document Management System - Web Services API Documentation

Lock

Locks a document or documents in the specified path.

Syntax

[Visual Basic]
Public Shared Function Lock(ByVal AuthenticationTicket As String, _
                            ByVal Path As String) as xmldocument

Parameters

AuthenticationTicket: infoRouter Authentication Ticket
PWD: infoRouter Login user password
Path: The path of a document or a folder to be locked (checked out)

Return Value

Returns XML fragment.
<response success="true" error="">
if success = "true" the document has been locked (checked-out).
if success = "false" the error attribute returns the error description.

Remarks

The caller must have at least "Change" permissions on the document(s) or must be the owner of the document(s).

Example

Public Sub Lock_Sample()
        Const IRAuthenticationTicket As String = "sid-xxxxxxxxxxxxxxxx"
        Const IR_DocumentPath As String = "Public/Images/NinePeople.jpg"
 
        Dim IR_Obj As InfoRouter.srv
        Dim xmlResponse As System.Xml.XmlElement
        Try
 
            IR_Obj = New InfoRouter.srv
 
            xmlResponse = IR_Obj.Lock(IRAuthenticationTicket, _
                                      IR_DocumentPath)

            If xmlResponse.GetAttribute("success") = "true" Then
                Console.WriteLine("The document has been Locked.")
            Else
                Console.WriteLine("The document cannot be Locked.")
                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