Description
Method for changing an entity's description in the repository.
Syntax
retval = Repository("SETDESCRIPTION" , entID)
Parameters
The SETDESCRIPTION method has the following parameters.
| Parameter | Description |
|---|---|
| Message | "SETDESCRIPTION" |
| entID | entID consists of four elements, which are '*' (asterisk) delimited: |
| |
| 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 | new description for the entity |
Returns
Null in all cases.
Note: Always call the Get_Status function after calling Repository.
See also
Repository() function, GETDESCRIPTION Method, Get_Repos_Entities().
Example
/* Change the description for the for the CENTERWINDOW stored procedure */
Declare Function Repository, Get_Status
AppID = @APPID<1> ;* current application
TypeID = "STPROCEXE" ;* OpenInsight stored procedure executable
ClassID = "" ;* Not Applicable
Stored_Proc_Name = 'CENTERWINDOW'
NewDescription = 'This is a new description set by calling the SETDESCRIPTION method.'
entid = AppID : '*' : TypeID : '*' : ClassID : '*' : Stored_Proc_Name
result = Repository("SETDESCRIPTION", entid, NewDescription)
/* result is null, need to check for errors */
If Get_Status(ErrCode) then
call msg(@window, 'SETDESCRIPTION error ' : ErrCode : '.')
return 1
end
