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


 
==== Description ====
 
Method for setting the list of "super-entities" (entities used by //entID//) in the repository.  Set manually in the Entity/Relate Used-By menu item when the repository entity is highlighted.
 
==== Syntax ====
 
//retval// = **Repository**('SETSUPER', //entID, param1//)
 
==== Parameters ====
 
The SETSUPER method has the following parameters.

^Parameter^Description^
|//Message//|'SETSUPER'|
|//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|A field mark delimited list of entities "super" to entid.|
|param2|A boolean indicating whether to overwrite the existing list (true) or combine with the existing list (false)|

 
==== Returns ====
 
Null, regardless of whether the function succeeded.

**Note:**  Always call the [[get_status|Get_Status function]] after calling Repository.
 
==== See Also ====
 
[[repository|Repository() function]], [[getsuper|GETSUPER Method]], [[get_repos_entities|Get_Repos_Entities()]]. Also, Stored Procedures chapter in the //Guide to Application Development//.
 
==== Example ====
 
<code>
/* Change the list of "super-entities" for the CENTERWINDOW stored procedure, overwriting the existing list. */

$insert logical

Declare Function Repository, Get_Status

AppID = @APPID<1>  ;* current application

TypeID = "STPROC"  ;* OpenInsight stored procedures

ClassID = ""  ;* Not Applicable

Stored_Proc_Name = 'CENTERWINDOW'

Super_Entities = @APPID<1>:"*STPROCEXE**CENTERWINDOW" : @fm : @APPID<1>:"*OIWIN**CENTERWINDOW"
 

overwrite_flag = TRUE$

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

result = Repository("SETSUPER", entid, Super_Entities, overwrite_flag)
 

/*  if successful, the list of super-entities is the stored procedure executable (STPROCEXE) and window (OIWIN) called "CENTERWINDOW". */

If Get_Status(ErrCode) then

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

end
</code>