FLAG 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.
====== FLAG Method ======


 
==== Description ====
 
Method for setting flags in the repository header for an entity.
 
==== Syntax ====
 
RetVal = Repository( 'FLAG', EntId, Param1, Param2, Param3, Param4, Param5)
 
==== Parameters ====
 
The FLAG method has the following parameters.

^Parameter^Description^
|//Message//|'FLAG'|
|//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.|
|param1|Contents of notes for that entity, accessed by Entity...Notes when an entity is highlighted in the repository outline.  A sample entity note is illustrated below:\\ \\  \\ \\ {{{guides:programming:programmers_reference_manual:entitynotes.gif?318x227}}|
|param2|Which flag to set if param4 is automatic.  Possible values are:\\ \\ 0 = set recompile flag\\ \\ 1 = set evaluation flag|
|param3|Sub-entity ID|
|param4|Which flags to set.  Possible values are:\\ \\ 0 = automatic (see param2 for whether recompile flag or automatic flag is set)\\ \\ 1 = set evaluation flag\\ \\ 2 = set recompile flag\\ \\ 3 = set evaluation flag and recompile flag|
|param5|whether or not the flag setting should apply to entities using this entity.  Set to 1 if this is desired.||

 
==== Returns ====
 
null

**Note:**  Always call the [[get_status|Get_Status function]] after calling Repository.
 
==== See Also ====
 
[[repository|Repository() function]], [[get_repos_entities|Get_Repos_Entities()]]. Also, Stored Procedures chapter in the //Guide to Application Development//.
 
==== Example ====
 
<code>
/* Add a note to the CENTERWINDOW stored procedure.  Set evaluation and recompile flags */

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'

noteparam = 'This is a note set through REPOSITORY("FLAG")'

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

 

result = Repository("FLAG", entid, noteparam, '' ,3,0,'')

If Get_Status(ErrCode) then

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

  return 1

end
</code>