LOCK Method [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== LOCK Method ======


 
==== Description ====
 
Method for locking an entity.  The lock is associated with the workstation issuing the call.
 
==== Syntax ====
 
//retval// = **Repository**('LOCK', //entID//)
 
==== Parameters ====
 
The LOCK method has the following parameters.

^Parameter^Description^
|//Message//|'LOCK'|
|//entID//|//entID// consists of four elements, which are '*' (asterisk) delimited:\\ \\ * Application name\\ * Type ID\\ * Class ID\\ * Entity name\\ \\ Methods are executed as follows:  if class specific, execute at the class level; if type specific, execute at the type level; otherwise, execute the method.|

 
==== Returns ====
 
Null, whether or not the LOCK is successful.

**Note:**  Always call the [[get_status|Get_Status function]] after calling Repository.
 
==== See Also ====
 
[[repository|Repository() function]], [[unlock_method|UNLOCK Method]], [[get_repos_entities|Get_Repos_Entities()]]. Also, Stored Procedures chapter in the //Guide to Application Development//.
 
==== Example ====
 
<code>
/* Lock the CENTERWINDOW stored procedure in the repository. */

Declare Function Get_Repos_Entities, Repository, Get_Status

AppID = @APPID<1>  ;* current application

TypeID = "STPROC"  ;* OpenInsight stored procedures

ClassID = ""  ;* Not Applicable

Stored_Proc_Name = 'CENTERWINDOW'

entid = AppID : '*' : TypeID : '*' : ClassID : '*' : Stored_Proc_Name

result = Repository("LOCK", entid)

/*  CENTERWINDOW is now marked as locked. The result field is null. */

If Get_Status(ErrCode) then

  call msg(@window, 'Error Message returned: ' : ErrCode)

end
</code>